dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

New upstream version 1.10.78+repack

Browse source
This commit is contained in:
TANIGUCHI Takaki 2018-08-16 15:01:54 +09:00
parent d004fbc02a
commit af632d9b93
92 changed files with 16570 additions and 1898 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.10.55
Version: 1.10.78
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services
@ -55,3 +55,4 @@ Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7

3
botocore.egg-info/PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.10.55
Version: 1.10.78
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services
@ -55,3 +55,4 @@ Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7

10
botocore.egg-info/SOURCES.txt
View file

@ -135,6 +135,10 @@ botocore/data/cloudfront/2017-10-30/examples-1.json
botocore/data/cloudfront/2017-10-30/paginators-1.json
botocore/data/cloudfront/2017-10-30/service-2.json
botocore/data/cloudfront/2017-10-30/waiters-2.json
botocore/data/cloudfront/2018-06-18/examples-1.json
botocore/data/cloudfront/2018-06-18/paginators-1.json
botocore/data/cloudfront/2018-06-18/service-2.json
botocore/data/cloudfront/2018-06-18/waiters-2.json
botocore/data/cloudhsm/2014-05-30/examples-1.json
botocore/data/cloudhsm/2014-05-30/paginators-1.json
botocore/data/cloudhsm/2014-05-30/service-2.json
@ -197,6 +201,8 @@ botocore/data/directconnect/2012-10-25/service-2.json
botocore/data/discovery/2015-11-01/examples-1.json
botocore/data/discovery/2015-11-01/paginators-1.json
botocore/data/discovery/2015-11-01/service-2.json
botocore/data/dlm/2018-01-12/paginators-1.json
botocore/data/dlm/2018-01-12/service-2.json
botocore/data/dms/2016-01-01/examples-1.json
botocore/data/dms/2016-01-01/paginators-1.json
botocore/data/dms/2016-01-01/service-2.json
@ -378,6 +384,7 @@ botocore/data/mgh/2017-05-31/paginators-1.json
botocore/data/mgh/2017-05-31/service-2.json
botocore/data/mobile/2017-07-01/paginators-1.json
botocore/data/mobile/2017-07-01/service-2.json
botocore/data/mq/2017-11-27/paginators-1.json
botocore/data/mq/2017-11-27/service-2.json
botocore/data/mturk/2017-01-17/paginators-1.json
botocore/data/mturk/2017-01-17/service-2.json
@ -689,8 +696,10 @@ tests/functional/test_cognito_idp.py
tests/functional/test_credentials.py
tests/functional/test_ec2.py
tests/functional/test_endpoints.py
tests/functional/test_h2_required.py
tests/functional/test_history.py
tests/functional/test_iot_data.py
tests/functional/test_kinesis.py
tests/functional/test_lex.py
tests/functional/test_loaders.py
tests/functional/test_machinelearning.py
@ -704,6 +713,7 @@ tests/functional/test_regions.py
tests/functional/test_retry.py
tests/functional/test_route53.py
tests/functional/test_s3.py
tests/functional/test_sagemaker.py
tests/functional/test_service_alias.py
tests/functional/test_service_names.py
tests/functional/test_session.py

2
botocore/__init__.py
View file

@ -16,7 +16,7 @@ import os
import re
import logging
__version__ = '1.10.55'
__version__ = '1.10.78'
class NullHandler(logging.Handler):

7
botocore/configloader.py
View file

@ -171,7 +171,12 @@ def raw_config_parse(config_filename, parse_subsections=True):
def _unicode_path(path):
if isinstance(path, six.text_type):
return path
return path.decode(sys.getfilesystemencoding(), 'replace')
# According to the documentation getfilesystemencoding can return None
# on unix in which case the default encoding is used instead.
filesystem_encoding = sys.getfilesystemencoding()
if filesystem_encoding is None:
filesystem_encoding = sys.getdefaultencoding()
return path.decode(filesystem_encoding, 'replace')
def _parse_nested(config_value):

19
botocore/data/alexaforbusiness/2017-11-09/service-2.json
View file

@ -356,7 +356,7 @@
"errors":[
{"shape":"NotFoundException"}
],
"documentation":"<p>Lists the Device Event history for up to 30 days. If EventType isn't specified in the request, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order. </p>"
"documentation":"<p>Lists the device event history, including device connection status, for up to 30 days.</p>"
},
"ListSkills":{
"name":"ListSkills",
@ -379,7 +379,7 @@
"errors":[
{"shape":"NotFoundException"}
],
"documentation":"<p>Lists all tags for a specific resource.</p>"
"documentation":"<p>Lists all tags for the specified resource.</p>"
},
"PutRoomSkillParameter":{
"name":"PutRoomSkillParameter",
@ -1317,6 +1317,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The request failed because this device is no longer registered and therefore no longer managed by this account.</p>",
"exception":true
},
"DeviceSerialNumber":{
@ -1677,15 +1678,15 @@
},
"EventType":{
"shape":"DeviceEventType",
"documentation":"<p>The event type to filter device events.</p>"
"documentation":"<p>The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.</p>"
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required. </p>"
"documentation":"<p>The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. </p>"
}
}
},
@ -1694,11 +1695,11 @@
"members":{
"DeviceEvents":{
"shape":"DeviceEventList",
"documentation":"<p/>"
"documentation":"<p>The device events requested for the device ARN.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p/>"
"documentation":"<p>The token returned to indicate that there is more data available.</p>"
}
}
},
@ -1738,7 +1739,7 @@
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the specific resource for which to list tags. Required.</p>"
"documentation":"<p>The ARN of the specified resource for which to list tags.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -1755,7 +1756,7 @@
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>The list of tags requested for the specific resource.</p>"
"documentation":"<p>The tags requested for the specified resource.</p>"
},
"NextToken":{
"shape":"NextToken",

9
botocore/data/apigateway/2015-07-09/service-2.json
View file

@ -2114,6 +2114,10 @@
"stage":{
"shape":"String",
"documentation":"<p>API stage name of the associated API stage in a usage plan.</p>"
},
"throttle":{
"shape":"MapOfApiStageThrottleSettings",
"documentation":"<p>Map containing method level throttling information for API stage in a usage plan.</p>"
}
},
"documentation":"<p>API stage name of the associated API stage in a usage plan.</p>"
@ -5117,6 +5121,11 @@
]
},
"Long":{"type":"long"},
"MapOfApiStageThrottleSettings":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"ThrottleSettings"}
},
"MapOfHeaderValues":{
"type":"map",
"key":{"shape":"String"},

232
botocore/data/appstream/2016-12-01/service-2.json
View file

@ -81,7 +81,8 @@
{"shape":"InvalidRoleException"},
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidParameterCombinationException"},
{"shape":"IncompatibleImageException"}
{"shape":"IncompatibleImageException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Creates a fleet. A fleet consists of streaming instances that run a specified image.</p>"
},
@ -102,7 +103,8 @@
{"shape":"InvalidRoleException"},
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidParameterCombinationException"},
{"shape":"IncompatibleImageException"}
{"shape":"IncompatibleImageException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Creates an image builder. An image builder is a virtual machine that is used to create an image.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>"
},
@ -215,6 +217,20 @@
],
"documentation":"<p>Deletes the specified image builder and releases the capacity.</p>"
},
"DeleteImagePermissions":{
"name":"DeleteImagePermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteImagePermissionsRequest"},
"output":{"shape":"DeleteImagePermissionsResult"},
"errors":[
{"shape":"ResourceNotAvailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.</p>"
},
"DeleteStack":{
"name":"DeleteStack",
"http":{
@ -269,6 +285,19 @@
],
"documentation":"<p>Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.</p>"
},
"DescribeImagePermissions":{
"name":"DescribeImagePermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeImagePermissionsRequest"},
"output":{"shape":"DescribeImagePermissionsResult"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves a list that describes the permissions for a private image that you own. </p>"
},
"DescribeImages":{
"name":"DescribeImages",
"http":{
@ -278,6 +307,7 @@
"input":{"shape":"DescribeImagesRequest"},
"output":{"shape":"DescribeImagesResult"},
"errors":[
{"shape":"InvalidParameterCombinationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves a list that describes one or more specified images, if the image names are provided. Otherwise, all images in the account are described.</p>"
@ -494,6 +524,21 @@
],
"documentation":"<p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code> and <code>ComputeCapacity</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>"
},
"UpdateImagePermissions":{
"name":"UpdateImagePermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateImagePermissionsRequest"},
"output":{"shape":"UpdateImagePermissionsResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceNotAvailableException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Adds or updates permissions for the specified private image. </p>"
},
"UpdateStack":{
"name":"UpdateStack",
"http":{
@ -584,6 +629,10 @@
"type":"string",
"pattern":"^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$"
},
"ArnList":{
"type":"list",
"member":{"shape":"Arn"}
},
"AssociateFleetRequest":{
"type":"structure",
"required":[
@ -614,6 +663,16 @@
"USERPOOL"
]
},
"AwsAccountId":{
"type":"string",
"pattern":"^\\d+$"
},
"AwsAccountIdList":{
"type":"list",
"member":{"shape":"AwsAccountId"},
"max":5,
"min":1
},
"Boolean":{"type":"boolean"},
"BooleanObject":{"type":"boolean"},
"ComputeCapacity":{
@ -728,7 +787,6 @@
"type":"structure",
"required":[
"Name",
"ImageName",
"InstanceType",
"ComputeCapacity"
],
@ -741,6 +799,10 @@
"shape":"String",
"documentation":"<p>The name of the image used to create the fleet.</p>"
},
"ImageArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the public, private, or shared image to use.</p>"
},
"InstanceType":{
"shape":"String",
"documentation":"<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>"
@ -796,7 +858,6 @@
"type":"structure",
"required":[
"Name",
"ImageName",
"InstanceType"
],
"members":{
@ -808,6 +869,10 @@
"shape":"String",
"documentation":"<p>The name of the image used to create the builder.</p>"
},
"ImageArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the public, private, or shared image to use.</p>"
},
"InstanceType":{
"shape":"String",
"documentation":"<p>The instance type to use when launching the image builder.</p>"
@ -1013,6 +1078,28 @@
}
}
},
"DeleteImagePermissionsRequest":{
"type":"structure",
"required":[
"Name",
"SharedAccountId"
],
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the private image.</p>"
},
"SharedAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The 12-digit ID of the AWS account for which to delete image permissions.</p>"
}
}
},
"DeleteImagePermissionsResult":{
"type":"structure",
"members":{
}
},
"DeleteImageRequest":{
"type":"structure",
"required":["Name"],
@ -1133,6 +1220,45 @@
}
}
},
"DescribeImagePermissionsRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the private image for which to describe permissions. The image must be one that you own. </p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum size of each results page.</p>"
},
"SharedAwsAccountIds":{
"shape":"AwsAccountIdList",
"documentation":"<p>The 12-digit ID of one or more AWS accounts with which the image is shared.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.</p>"
}
}
},
"DescribeImagePermissionsResult":{
"type":"structure",
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the private image.</p>"
},
"SharedImagePermissionsList":{
"shape":"SharedImagePermissionsList",
"documentation":"<p>The permissions for a private image that you own. </p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.</p>"
}
}
},
"DescribeImagesMaxResults":{
"type":"integer",
"box":true,
@ -1146,13 +1272,21 @@
"shape":"StringList",
"documentation":"<p>The names of the images to describe.</p>"
},
"Arns":{
"shape":"ArnList",
"documentation":"<p>The ARNs of the public, private, and shared images to describe.</p>"
},
"Type":{
"shape":"VisibilityType",
"documentation":"<p>The type of image (public, private, or shared) to describe. </p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.</p>"
},
"MaxResults":{
"shape":"DescribeImagesMaxResults",
"documentation":"<p>The maximum size of each results page.</p>"
"documentation":"<p>The maximum size of each page of results.</p>"
}
}
},
@ -1165,7 +1299,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The pagination token used to retrieve the next page of results. If this value is empty, only the first page is retrieved.</p>"
"documentation":"<p>The pagination token to use to retrieve the next page of results. If there are no more pages, this value is null.</p>"
}
}
},
@ -1355,7 +1489,6 @@
"required":[
"Arn",
"Name",
"ImageName",
"InstanceType",
"ComputeCapacityStatus",
"State"
@ -1381,6 +1514,10 @@
"shape":"String",
"documentation":"<p>The name of the image used to create the fleet.</p>"
},
"ImageArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the public, private, or shared image.</p>"
},
"InstanceType":{
"shape":"String",
"documentation":"<p>The instance type to use when launching fleet instances.</p>"
@ -1571,6 +1708,10 @@
"AppstreamAgentVersion":{
"shape":"AppstreamAgentVersion",
"documentation":"<p>The version of the AppStream 2.0 agent to use for instances that are launched from this image. </p>"
},
"ImagePermissions":{
"shape":"ImagePermissions",
"documentation":"<p>The permissions to provide to the destination AWS account for the specified image.</p>"
}
},
"documentation":"<p>Describes an image.</p>"
@ -1685,6 +1826,20 @@
"type":"list",
"member":{"shape":"Image"}
},
"ImagePermissions":{
"type":"structure",
"members":{
"allowFleet":{
"shape":"BooleanObject",
"documentation":"<p>Indicates whether the image can be used for a fleet.</p>"
},
"allowImageBuilder":{
"shape":"BooleanObject",
"documentation":"<p>Indicates whether the image can be used for an image builder.</p>"
}
},
"documentation":"<p>Describes the permissions for an image. </p>"
},
"ImageState":{
"type":"string",
"enum":[
@ -1832,6 +1987,12 @@
}
},
"Long":{"type":"long"},
"MaxResults":{
"type":"integer",
"box":true,
"max":500,
"min":0
},
"Metadata":{
"type":"map",
"key":{"shape":"String"},
@ -2029,6 +2190,28 @@
"EXPIRED"
]
},
"SharedImagePermissions":{
"type":"structure",
"required":[
"sharedAccountId",
"imagePermissions"
],
"members":{
"sharedAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The 12-digit ID of the AWS account with which the image is shared.</p>"
},
"imagePermissions":{
"shape":"ImagePermissions",
"documentation":"<p>Describes the permissions for a shared image.</p>"
}
},
"documentation":"<p>Describes the permissions that are available to the specified AWS account for a shared image.</p>"
},
"SharedImagePermissionsList":{
"type":"list",
"member":{"shape":"SharedImagePermissions"}
},
"Stack":{
"type":"structure",
"required":["Name"],
@ -2347,12 +2530,15 @@
},
"UpdateFleetRequest":{
"type":"structure",
"required":["Name"],
"members":{
"ImageName":{
"shape":"String",
"documentation":"<p>The name of the image used to create the fleet.</p>"
},
"ImageArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the public, private, or shared image to use.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>A unique name for the fleet.</p>"
@ -2413,6 +2599,33 @@
}
}
},
"UpdateImagePermissionsRequest":{
"type":"structure",
"required":[
"Name",
"SharedAccountId",
"ImagePermissions"
],
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the private image.</p>"
},
"SharedAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The 12-digit ID of the AWS account for which you want add or update image permissions.</p>"
},
"ImagePermissions":{
"shape":"ImagePermissions",
"documentation":"<p>The permissions for the image.</p>"
}
}
},
"UpdateImagePermissionsResult":{
"type":"structure",
"members":{
}
},
"UpdateStackRequest":{
"type":"structure",
"required":["Name"],
@ -2497,7 +2710,8 @@
"type":"string",
"enum":[
"PUBLIC",
"PRIVATE"
"PRIVATE",
"SHARED"
]
},
"VpcConfig":{

27
botocore/data/appsync/2017-07-25/service-2.json
View file

@ -613,6 +613,10 @@
"elasticsearchConfig":{
"shape":"ElasticsearchDataSourceConfig",
"documentation":"<p>Amazon Elasticsearch settings.</p>"
},
"httpConfig":{
"shape":"HttpDataSourceConfig",
"documentation":"<p>Http endpoint settings.</p>"
}
}
},
@ -762,7 +766,7 @@
},
"type":{
"shape":"DataSourceType",
"documentation":"<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.</p> </li> </ul>"
"documentation":"<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.</p> </li> <li> <p> <b>HTTP</b>: The data source is an HTTP endpoint.</p> </li> </ul>"
},
"serviceRoleArn":{
"shape":"String",
@ -779,6 +783,10 @@
"elasticsearchConfig":{
"shape":"ElasticsearchDataSourceConfig",
"documentation":"<p>Amazon Elasticsearch settings.</p>"
},
"httpConfig":{
"shape":"HttpDataSourceConfig",
"documentation":"<p>Http endpoint settings.</p>"
}
},
"documentation":"<p>Describes a data source.</p>"
@ -789,7 +797,8 @@
"AWS_LAMBDA",
"AMAZON_DYNAMODB",
"AMAZON_ELASTICSEARCH",
"NONE"
"NONE",
"HTTP"
]
},
"DataSources":{
@ -1212,6 +1221,16 @@
"type":"list",
"member":{"shape":"GraphqlApi"}
},
"HttpDataSourceConfig":{
"type":"structure",
"members":{
"endpoint":{
"shape":"String",
"documentation":"<p>The Http url endpoint. You can either specify the domain name or ip and port combination and the url scheme must be http(s). If the port is not specified, AWS AppSync will use the default port 80 for http endpoint and port 443 for https endpoints.</p>"
}
},
"documentation":"<p>Describes a Http data source configuration.</p>"
},
"InternalFailureException":{
"type":"structure",
"members":{
@ -1717,6 +1736,10 @@
"elasticsearchConfig":{
"shape":"ElasticsearchDataSourceConfig",
"documentation":"<p>The new Elasticsearch configuration.</p>"
},
"httpConfig":{
"shape":"HttpDataSourceConfig",
"documentation":"<p>The new http endpoint configuration</p>"
}
}
},

324
botocore/data/autoscaling/2011-01-01/service-2.json
View file

@ -22,7 +22,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"AttachLoadBalancerTargetGroups":{
"name":"AttachLoadBalancerTargetGroups",
@ -39,7 +39,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"AttachLoadBalancers":{
"name":"AttachLoadBalancers",
@ -56,7 +56,41 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group.</p> <p>To attach an Application Load Balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group.</p> <p>To attach an Application Load Balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"BatchDeleteScheduledAction":{
"name":"BatchDeleteScheduledAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDeleteScheduledActionType"},
"output":{
"shape":"BatchDeleteScheduledActionAnswer",
"resultWrapper":"BatchDeleteScheduledActionResult"
},
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes one or more scheduled actions for the specified Auto Scaling group.</p>"
},
"BatchPutScheduledUpdateGroupAction":{
"name":"BatchPutScheduledUpdateGroupAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchPutScheduledUpdateGroupActionType"},
"output":{
"shape":"BatchPutScheduledUpdateGroupActionAnswer",
"resultWrapper":"BatchPutScheduledUpdateGroupActionResult"
},
"errors":[
{"shape":"AlreadyExistsFault"},
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates one or more scheduled scaling actions for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged.</p>"
},
"CompleteLifecycleAction":{
"name":"CompleteLifecycleAction",
@ -72,7 +106,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, complete the lifecycle action.</b> </p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, complete the lifecycle action.</b> </p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CreateAutoScalingGroup":{
"name":"CreateAutoScalingGroup",
@ -87,7 +121,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CreateLaunchConfiguration":{
"name":"CreateLaunchConfiguration",
@ -101,7 +135,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CreateOrUpdateTags":{
"name":"CreateOrUpdateTags",
@ -116,7 +150,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ResourceInUseFault"}
],
"documentation":"<p>Creates or updates tags for the specified Auto Scaling group.</p> <p>When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates or updates tags for the specified Auto Scaling group.</p> <p>When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"DeleteAutoScalingGroup":{
"name":"DeleteAutoScalingGroup",
@ -130,7 +164,7 @@
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Deletes the specified Auto Scaling group.</p> <p>If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.</p> <p>If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.</p> <p>To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances.</p> <p>To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero.</p>"
"documentation":"<p>Deletes the specified Auto Scaling group.</p> <p>If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.</p> <p>If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.</p> <p>To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Amazon EC2 Auto Scaling does not launch replacement instances.</p> <p>To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero.</p>"
},
"DeleteLaunchConfiguration":{
"name":"DeleteLaunchConfiguration",
@ -224,7 +258,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the current Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes the current Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"DescribeAdjustmentTypes":{
"name":"DescribeAdjustmentTypes",
@ -288,7 +322,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the notification types that are supported by Auto Scaling.</p>"
"documentation":"<p>Describes the notification types that are supported by Amazon EC2 Auto Scaling.</p>"
},
"DescribeLaunchConfigurations":{
"name":"DescribeLaunchConfigurations",
@ -320,7 +354,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the available types of lifecycle hooks.</p>"
"documentation":"<p>Describes the available types of lifecycle hooks.</p> <p>The following hook types are supported:</p> <ul> <li> <p>autoscaling:EC2_INSTANCE_LAUNCHING</p> </li> <li> <p>autoscaling:EC2_INSTANCE_TERMINATING</p> </li> </ul>"
},
"DescribeLifecycleHooks":{
"name":"DescribeLifecycleHooks",
@ -383,7 +417,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the available CloudWatch metrics for Auto Scaling.</p> <p>Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>.</p>"
"documentation":"<p>Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.</p> <p>Note that the <code>GroupStandbyInstances</code> metric is not returned by default. You must explicitly request this metric when calling <a>EnableMetricsCollection</a>.</p>"
},
"DescribeNotificationConfigurations":{
"name":"DescribeNotificationConfigurations",
@ -499,7 +533,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes the termination policies supported by Auto Scaling.</p>"
"documentation":"<p>Describes the termination policies supported by Amazon EC2 Auto Scaling.</p>"
},
"DetachInstances":{
"name":"DetachInstances",
@ -515,7 +549,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independent of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independent of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"DetachLoadBalancerTargetGroups":{
"name":"DetachLoadBalancerTargetGroups",
@ -571,7 +605,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Enables group metrics for the specified Auto Scaling group. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html\">Monitoring Your Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Enables group metrics for the specified Auto Scaling group. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html\">Monitoring Your Auto Scaling Groups and Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"EnterStandby":{
"name":"EnterStandby",
@ -587,7 +621,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Moves the specified instances into the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Moves the specified instances into the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ExecutePolicy":{
"name":"ExecutePolicy",
@ -616,7 +650,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Moves the specified instances out of the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Moves the specified instances out of the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"PutLifecycleHook":{
"name":"PutLifecycleHook",
@ -633,7 +667,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling Group.</p> <p>A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"documentation":"<p>Creates or updates a lifecycle hook for the specified Auto Scaling Group.</p> <p>A lifecycle hook tells Amazon EC2 Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>"
},
"PutNotificationConfiguration":{
"name":"PutNotificationConfiguration",
@ -647,7 +681,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ServiceLinkedRoleFailure"}
],
"documentation":"<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/ASGettingNotifications.html\">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html\">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
@ -679,7 +713,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/schedule_time.html\">Scheduled Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html\">Scheduled Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"RecordLifecycleActionHeartbeat":{
"name":"RecordLifecycleActionHeartbeat",
@ -695,7 +729,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p> <b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b> </p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using <a>PutLifecycleHook</a>.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p> <b>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</b> </p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ResumeProcesses":{
"name":"ResumeProcesses",
@ -708,7 +742,7 @@
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Scaling Processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"SetDesiredCapacity":{
"name":"SetDesiredCapacity",
@ -721,7 +755,7 @@
{"shape":"ScalingActivityInProgressFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Sets the size of the specified Auto Scaling group.</p> <p>For more information about desired capacity, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/WhatIsAutoScaling.html\">What Is Auto Scaling?</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Sets the size of the specified Auto Scaling group.</p> <p>For more information about desired capacity, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/WhatIsAutoScaling.html\">What Is Amazon EC2 Auto Scaling?</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"SetInstanceHealth":{
"name":"SetInstanceHealth",
@ -733,7 +767,7 @@
"errors":[
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Sets the health status of the specified instance.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Sets the health status of the specified instance.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html\">Health Checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"SetInstanceProtection":{
"name":"SetInstanceProtection",
@ -750,7 +784,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Updates the instance protection settings of the specified instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Updates the instance protection settings of the specified instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"SuspendProcesses":{
"name":"SuspendProcesses",
@ -763,7 +797,7 @@
{"shape":"ResourceInUseFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.</p> <p>Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly.</p> <p>To resume processes that have been suspended, use <a>ResumeProcesses</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.</p> <p>Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly.</p> <p>To resume processes that have been suspended, use <a>ResumeProcesses</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Scaling Processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"TerminateInstanceInAutoScalingGroup":{
"name":"TerminateInstanceInAutoScalingGroup",
@ -890,7 +924,7 @@
"documentation":"<p>The policy adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>"
}
},
"documentation":"<p>Describes a policy adjustment type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a policy adjustment type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/DeveloperGuide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"AdjustmentTypes":{
"type":"list",
@ -1058,7 +1092,7 @@
},
"HealthCheckGracePeriod":{
"shape":"HealthCheckGracePeriod",
"documentation":"<p>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service.</p>"
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.</p>"
},
"Instances":{
"shape":"Instances",
@ -1119,7 +1153,7 @@
"members":{
"AutoScalingGroupNames":{
"shape":"AutoScalingGroupNames",
"documentation":"<p>The names of the Auto Scaling groups. If you omit this parameter, all Auto Scaling groups are described.</p>"
"documentation":"<p>The names of the Auto Scaling groups. You can specify up to <code>MaxRecords</code> names. If you omit this parameter, all Auto Scaling groups are described.</p>"
},
"NextToken":{
"shape":"XmlString",
@ -1174,11 +1208,11 @@
},
"LifecycleState":{
"shape":"XmlStringMaxLen32",
"documentation":"<p>The lifecycle state for the instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The lifecycle state for the instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"HealthStatus":{
"shape":"XmlStringMaxLen32",
"documentation":"<p>The last reported health status of this instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and Auto Scaling should terminate and replace it.</p>"
"documentation":"<p>The last reported health status of this instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.</p>"
},
"LaunchConfigurationName":{
"shape":"XmlStringMaxLen255",
@ -1190,7 +1224,7 @@
},
"ProtectedFromScaleIn":{
"shape":"InstanceProtected",
"documentation":"<p>Indicates whether the instance is protected from termination by Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p>"
}
},
"documentation":"<p>Describes an EC2 instance associated with an Auto Scaling group.</p>"
@ -1221,6 +1255,58 @@
"member":{"shape":"XmlStringMaxLen255"},
"min":1
},
"BatchDeleteScheduledActionAnswer":{
"type":"structure",
"members":{
"FailedScheduledActions":{
"shape":"FailedScheduledUpdateGroupActionRequests",
"documentation":"<p>The names of the scheduled actions that could not be deleted, including an error message. </p>"
}
}
},
"BatchDeleteScheduledActionType":{
"type":"structure",
"required":[
"AutoScalingGroupName",
"ScheduledActionNames"
],
"members":{
"AutoScalingGroupName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Auto Scaling group.</p>"
},
"ScheduledActionNames":{
"shape":"ScheduledActionNames",
"documentation":"<p>The names of the scheduled actions to delete. The maximum number allowed is 50. </p>"
}
}
},
"BatchPutScheduledUpdateGroupActionAnswer":{
"type":"structure",
"members":{
"FailedScheduledUpdateGroupActions":{
"shape":"FailedScheduledUpdateGroupActionRequests",
"documentation":"<p>The names of the scheduled actions that could not be created or updated, including an error message.</p>"
}
}
},
"BatchPutScheduledUpdateGroupActionType":{
"type":"structure",
"required":[
"AutoScalingGroupName",
"ScheduledUpdateGroupActions"
],
"members":{
"AutoScalingGroupName":{
"shape":"ResourceName",
"documentation":"<p>The name of the Auto Scaling group.</p>"
},
"ScheduledUpdateGroupActions":{
"shape":"ScheduledUpdateGroupActionRequests",
"documentation":"<p>One or more scheduled actions. The maximum number allowed is 50. </p>"
}
}
},
"BlockDeviceEbsDeleteOnTermination":{"type":"boolean"},
"BlockDeviceEbsEncrypted":{"type":"boolean"},
"BlockDeviceEbsIops":{
@ -1256,7 +1342,7 @@
},
"NoDevice":{
"shape":"NoDevice",
"documentation":"<p>Suppresses a device mapping.</p> <p>If this parameter is true for the root device, the instance might fail the EC2 health check. Auto Scaling launches a replacement instance if the instance fails the health check.</p>"
"documentation":"<p>Suppresses a device mapping.</p> <p>If this parameter is true for the root device, the instance might fail the EC2 health check. Amazon EC2 Auto Scaling launches a replacement instance if the instance fails the health check.</p>"
}
},
"documentation":"<p>Describes a block device mapping.</p>"
@ -1292,7 +1378,7 @@
},
"LifecycleActionToken":{
"shape":"LifecycleActionToken",
"documentation":"<p>A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.</p>"
"documentation":"<p>A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.</p>"
},
"LifecycleActionResult":{
"shape":"LifecycleActionResult",
@ -1327,7 +1413,7 @@
},
"InstanceId":{
"shape":"XmlStringMaxLen19",
"documentation":"<p>The ID of the instance used to create a launch configuration for the group. You must specify one of the following: an EC2 instance, a launch configuration, or a launch template.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The ID of the instance used to create a launch configuration for the group. You must specify one of the following: an EC2 instance, a launch configuration, or a launch template.</p> <p>When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -1343,7 +1429,7 @@
},
"DefaultCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZones",
@ -1351,7 +1437,7 @@
},
"LoadBalancerNames":{
"shape":"LoadBalancerNames",
"documentation":"<p>One or more Classic Load Balancers. To specify an Application Load Balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more Classic Load Balancers. To specify an Application Load Balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"TargetGroupARNs":{
"shape":"TargetGroupARNs",
@ -1359,11 +1445,11 @@
},
"HealthCheckType":{
"shape":"XmlStringMaxLen32",
"documentation":"<p>The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>.</p> <p>By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The service to use for the health checks. The valid values are <code>EC2</code> and <code>ELB</code>.</p> <p>By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html\">Health Checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"HealthCheckGracePeriod":{
"shape":"HealthCheckGracePeriod",
"documentation":"<p>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.</p> <p>This parameter is required if you are adding an <code>ELB</code> health check.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.</p> <p>This parameter is required if you are adding an <code>ELB</code> health check.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html\">Health Checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
@ -1371,11 +1457,11 @@
},
"VPCZoneIdentifier":{
"shape":"XmlStringMaxLen2047",
"documentation":"<p>A comma-separated list of subnet identifiers for your virtual private cloud (VPC).</p> <p>If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>A comma-separated list of subnet identifiers for your virtual private cloud (VPC).</p> <p>If you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones match the Availability Zones specified.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"TerminationPolicies":{
"shape":"TerminationPolicies",
"documentation":"<p>One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"NewInstancesProtectedFromScaleIn":{
"shape":"InstanceProtected",
@ -1387,11 +1473,11 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>One or more tags.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>One or more tags.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"ServiceLinkedRoleARN":{
"shape":"ResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist.</p>"
}
}
},
@ -1429,7 +1515,7 @@
},
"InstanceId":{
"shape":"XmlStringMaxLen19",
"documentation":"<p>The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>If you do not specify <code>InstanceId</code>, you must specify both <code>ImageId</code> and <code>InstanceType</code>.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>If you do not specify <code>InstanceId</code>, you must specify both <code>ImageId</code> and <code>InstanceType</code>.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"InstanceType":{
"shape":"XmlStringMaxLen255",
@ -1453,11 +1539,11 @@
},
"SpotPrice":{
"shape":"SpotPrice",
"documentation":"<p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/US-SpotInstances.html\">Launching Spot Instances in Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html\">Launching Spot Instances in Your Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"IamInstanceProfile":{
"shape":"XmlStringMaxLen1600",
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p> <p>EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/us-iam-role.html\">Launch Auto Scaling Instances with an IAM Role</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.</p> <p>EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Amazon EC2 Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html\">Launch Auto Scaling Instances with an IAM Role</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"EbsOptimized":{
"shape":"EbsOptimized",
@ -1465,11 +1551,11 @@
},
"AssociatePublicIpAddress":{
"shape":"AssociatePublicIpAddress",
"documentation":"<p>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.</p>"
"documentation":"<p>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.</p>"
},
"PlacementTenancy":{
"shape":"XmlStringMaxLen64",
"documentation":"<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</p> <p>You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>).</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>"
"documentation":"<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</p> <p>You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>).</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>"
}
}
},
@ -1643,7 +1729,7 @@
"members":{
"InstanceIds":{
"shape":"InstanceIds",
"documentation":"<p>The instances to describe; up to 50 instance IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.</p>"
"documentation":"<p>The IDs of the instances. You can specify up to <code>MaxRecords</code> IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.</p>"
},
"MaxRecords":{
"shape":"MaxRecords",
@ -1832,7 +1918,7 @@
"members":{
"ActivityIds":{
"shape":"ActivityIds",
"documentation":"<p>The activity IDs of the desired scaling activities. If you omit this parameter, all activities for the past six weeks are described. If you specify an Auto Scaling group, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.</p>"
"documentation":"<p>The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.</p>"
},
"AutoScalingGroupName":{
"shape":"ResourceName",
@ -1857,7 +1943,7 @@
},
"ScheduledActionNames":{
"shape":"ScheduledActionNames",
"documentation":"<p>Describes one or more scheduled actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.</p> <p>You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token.</p>"
"documentation":"<p>The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.</p>"
},
"StartTime":{
"shape":"TimestampType",
@ -1899,7 +1985,7 @@
"members":{
"TerminationPolicyTypes":{
"shape":"TerminationPolicies",
"documentation":"<p>The termination policies supported by Auto Scaling (<code>OldestInstance</code>, <code>OldestLaunchConfiguration</code>, <code>NewestInstance</code>, <code>ClosestToNextInstanceHour</code>, and <code>Default</code>).</p>"
"documentation":"<p>The termination policies supported by Amazon EC2 Auto Scaling (<code>OldestInstance</code>, <code>OldestLaunchConfiguration</code>, <code>NewestInstance</code>, <code>ClosestToNextInstanceHour</code>, and <code>Default</code>).</p>"
}
}
},
@ -2005,7 +2091,7 @@
},
"VolumeType":{
"shape":"BlockDeviceEbsVolumeType",
"documentation":"<p>The volume type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS Volume Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> </p> <p>Default: <code>standard</code> </p>"
"documentation":"<p>The volume type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS Volume Types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> </p>"
},
"DeleteOnTermination":{
"shape":"BlockDeviceEbsDeleteOnTermination",
@ -2107,7 +2193,7 @@
},
"HonorCooldown":{
"shape":"HonorCooldown",
"documentation":"<p>Indicates whether Auto Scaling waits for the cooldown period to complete before executing the policy.</p> <p>This parameter is not supported if the policy type is <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.</p> <p>This parameter is not supported if the policy type is <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"MetricValue":{
"shape":"MetricScale",
@ -2142,6 +2228,29 @@
}
}
},
"FailedScheduledUpdateGroupActionRequest":{
"type":"structure",
"required":["ScheduledActionName"],
"members":{
"ScheduledActionName":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the scheduled action.</p>"
},
"ErrorCode":{
"shape":"XmlStringMaxLen64",
"documentation":"<p>The error code.</p>"
},
"ErrorMessage":{
"shape":"XmlString",
"documentation":"<p>The error message accompanying the error code.</p>"
}
},
"documentation":"<p>Describes a scheduled action that could not be created, updated, or deleted.</p>"
},
"FailedScheduledUpdateGroupActionRequests":{
"type":"list",
"member":{"shape":"FailedScheduledUpdateGroupActionRequest"}
},
"Filter":{
"type":"structure",
"members":{
@ -2189,7 +2298,7 @@
},
"HealthStatus":{
"shape":"XmlStringMaxLen32",
"documentation":"<p>The last reported health status of the instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and Auto Scaling should terminate and replace it.</p>"
"documentation":"<p>The last reported health status of the instance. \"Healthy\" means that the instance is healthy and should remain in service. \"Unhealthy\" means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.</p>"
},
"LaunchConfigurationName":{
"shape":"XmlStringMaxLen255",
@ -2201,7 +2310,7 @@
},
"ProtectedFromScaleIn":{
"shape":"InstanceProtected",
"documentation":"<p>Indicates whether the instance is protected from termination by Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p>"
}
},
"documentation":"<p>Describes an EC2 instance.</p>"
@ -2397,7 +2506,7 @@
},
"Version":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The version number, <code>$Latest</code>, or <code>$Default</code>. If the value is <code>$Latest</code>, Auto Scaling selects the latest version of the launch template when launching instances. If the value is <code>$Default</code>, Auto Scaling selects the default version of the launch template when launching instances. The default value is <code>$Default</code>.</p>"
"documentation":"<p>The version number, <code>$Latest</code>, or <code>$Default</code>. If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is <code>$Default</code>.</p>"
}
},
"documentation":"<p>Describes a launch template.</p>"
@ -2421,11 +2530,11 @@
},
"LifecycleTransition":{
"shape":"LifecycleTransition",
"documentation":"<p>The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>.</p>"
"documentation":"<p>The state of the EC2 instance to which you want to attach the lifecycle hook. The following are possible values:</p> <ul> <li> <p>autoscaling:EC2_INSTANCE_LAUNCHING</p> </li> <li> <p>autoscaling:EC2_INSTANCE_TERMINATING</p> </li> </ul>"
},
"NotificationTargetARN":{
"shape":"ResourceName",
"documentation":"<p>The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>"
"documentation":"<p>The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>"
},
"RoleARN":{
"shape":"ResourceName",
@ -2433,11 +2542,11 @@
},
"NotificationMetadata":{
"shape":"XmlStringMaxLen1023",
"documentation":"<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>"
"documentation":"<p>Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.</p>"
},
"HeartbeatTimeout":{
"shape":"HeartbeatTimeout",
"documentation":"<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>"
"documentation":"<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>"
},
"GlobalTimeout":{
"shape":"GlobalTimeout",
@ -2448,7 +2557,7 @@
"documentation":"<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>"
}
},
"documentation":"<p>Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"LifecycleHookNames":{
"type":"list",
@ -2468,15 +2577,15 @@
},
"LifecycleTransition":{
"shape":"LifecycleTransition",
"documentation":"<p>The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>.</p>"
"documentation":"<p>The state of the EC2 instance to which you want to attach the lifecycle hook. The possible values are:</p> <ul> <li> <p>autoscaling:EC2_INSTANCE_LAUNCHING</p> </li> <li> <p>autoscaling:EC2_INSTANCE_TERMINATING</p> </li> </ul>"
},
"NotificationMetadata":{
"shape":"XmlStringMaxLen1023",
"documentation":"<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>"
"documentation":"<p>Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.</p>"
},
"HeartbeatTimeout":{
"shape":"HeartbeatTimeout",
"documentation":"<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>"
"documentation":"<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>"
},
"DefaultResult":{
"shape":"LifecycleActionResult",
@ -2484,14 +2593,14 @@
},
"NotificationTargetARN":{
"shape":"NotificationTargetResourceName",
"documentation":"<p>The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>"
"documentation":"<p>The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>"
},
"RoleARN":{
"shape":"ResourceName",
"documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>"
}
},
"documentation":"<p>Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html\">Lifecycle Hooks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"LifecycleHookSpecifications":{
"type":"list",
@ -2759,7 +2868,7 @@
"documentation":"<p>One of the following processes:</p> <ul> <li> <p> <code>Launch</code> </p> </li> <li> <p> <code>Terminate</code> </p> </li> <li> <p> <code>AddToLoadBalancer</code> </p> </li> <li> <p> <code>AlarmNotification</code> </p> </li> <li> <p> <code>AZRebalance</code> </p> </li> <li> <p> <code>HealthCheck</code> </p> </li> <li> <p> <code>ReplaceUnhealthy</code> </p> </li> <li> <p> <code>ScheduledActions</code> </p> </li> </ul>"
}
},
"documentation":"<p>Describes a process type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html#process-types\">Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Describes a process type.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types\">Scaling Processes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"Processes":{
"type":"list",
@ -2799,7 +2908,7 @@
},
"LifecycleTransition":{
"shape":"LifecycleTransition",
"documentation":"<p>The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>.</p> <p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>"
"documentation":"<p>The instance state to which you want to attach the lifecycle hook. The possible values are:</p> <ul> <li> <p>autoscaling:EC2_INSTANCE_LAUNCHING</p> </li> <li> <p>autoscaling:EC2_INSTANCE_TERMINATING</p> </li> </ul> <p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>"
},
"RoleARN":{
"shape":"ResourceName",
@ -2807,15 +2916,15 @@
},
"NotificationTargetARN":{
"shape":"NotificationTargetResourceName",
"documentation":"<p>The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.</p> <p>This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.</p> <p>When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: <code>\"Event\": \"autoscaling:TEST_NOTIFICATION\"</code>.</p>"
"documentation":"<p>The ARN of the notification target that Amazon EC2 Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.</p> <p>This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.</p> <p>When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: <code>\"Event\": \"autoscaling:TEST_NOTIFICATION\"</code>.</p>"
},
"NotificationMetadata":{
"shape":"XmlStringMaxLen1023",
"documentation":"<p>Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>"
"documentation":"<p>Contains additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.</p>"
},
"HeartbeatTimeout":{
"shape":"HeartbeatTimeout",
"documentation":"<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default is 3600 seconds (1 hour).</p> <p>If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>"
"documentation":"<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default is 3600 seconds (1 hour).</p> <p>If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>"
},
"DefaultResult":{
"shape":"LifecycleActionResult",
@ -2841,7 +2950,7 @@
},
"NotificationTypes":{
"shape":"AutoScalingNotificationTypes",
"documentation":"<p>The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see <a>DescribeAutoScalingNotificationTypes</a>.</p>"
"documentation":"<p>The type of event that will cause the notification to be sent. For details about notification types supported by Amazon EC2 Auto Scaling, see <a>DescribeAutoScalingNotificationTypes</a>.</p>"
}
}
},
@ -2866,7 +2975,7 @@
},
"AdjustmentType":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code> or <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code> or <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html\">Dynamic Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"MinAdjustmentStep":{
"shape":"MinAdjustmentStep",
@ -2882,7 +2991,7 @@
},
"Cooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"MetricAggregationType":{
"shape":"XmlStringMaxLen32",
@ -2923,15 +3032,15 @@
},
"StartTime":{
"shape":"TimestampType",
"documentation":"<p>The time for this action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, <code>2014-06-01T00:00:00Z</code>).</p> <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.</p> <p>If you try to schedule your action in the past, Auto Scaling returns an error message.</p>"
"documentation":"<p>The time for this action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, <code>2014-06-01T00:00:00Z</code>).</p> <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.</p> <p>If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.</p>"
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The time for the recurring schedule to end. Auto Scaling does not perform the action after this time.</p>"
"documentation":"<p>The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.</p>"
},
"Recurrence":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The recurring schedule for this action, in Unix cron syntax format. For more information, see <a href=\"http://en.wikipedia.org/wiki/Cron\">Cron</a> in Wikipedia.</p>"
"documentation":"<p>The recurring schedule for this action, in Unix cron syntax format. For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -2969,7 +3078,7 @@
},
"LifecycleActionToken":{
"shape":"LifecycleActionToken",
"documentation":"<p>A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.</p>"
"documentation":"<p>A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.</p>"
},
"InstanceId":{
"shape":"XmlStringMaxLen19",
@ -3189,7 +3298,46 @@
"documentation":"<p>The number of instances you prefer to maintain in the group.</p>"
}
},
"documentation":"<p>Describes a scheduled update to an Auto Scaling group.</p>"
"documentation":"<p>Describes a scheduled scaling action. Used in response to <a>DescribeScheduledActions</a>. </p>"
},
"ScheduledUpdateGroupActionRequest":{
"type":"structure",
"required":["ScheduledActionName"],
"members":{
"ScheduledActionName":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the scaling action.</p>"
},
"StartTime":{
"shape":"TimestampType",
"documentation":"<p>The time for the action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, <code>2014-06-01T00:00:00Z</code>).</p> <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.</p> <p>If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.</p>"
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.</p>"
},
"Recurrence":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The recurring schedule for the action, in Unix cron syntax format. For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
"documentation":"<p>The minimum size of the group.</p>"
},
"MaxSize":{
"shape":"AutoScalingGroupMaxSize",
"documentation":"<p>The maximum size of the group.</p>"
},
"DesiredCapacity":{
"shape":"AutoScalingGroupDesiredCapacity",
"documentation":"<p>The number of EC2 instances that should be running in the group.</p>"
}
},
"documentation":"<p>Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with <a>BatchPutScheduledUpdateGroupAction</a>. </p> <p>When updating a scheduled scaling action, all optional parameters are left unchanged if not specified. </p>"
},
"ScheduledUpdateGroupActionRequests":{
"type":"list",
"member":{"shape":"ScheduledUpdateGroupActionRequest"}
},
"ScheduledUpdateGroupActions":{
"type":"list",
@ -3229,7 +3377,7 @@
},
"HonorCooldown":{
"shape":"HonorCooldown",
"documentation":"<p>Indicates whether Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Auto Scaling does not honor the cooldown period during manual scaling activities.</p>"
"documentation":"<p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.</p>"
}
}
},
@ -3246,7 +3394,7 @@
},
"HealthStatus":{
"shape":"XmlStringMaxLen32",
"documentation":"<p>The health status of the instance. Set to <code>Healthy</code> if you want the instance to remain in service. Set to <code>Unhealthy</code> if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.</p>"
"documentation":"<p>The health status of the instance. Set to <code>Healthy</code> if you want the instance to remain in service. Set to <code>Unhealthy</code> if you want the instance to be out of service. Amazon EC2 Auto Scaling will terminate and replace the unhealthy instance.</p>"
},
"ShouldRespectGracePeriod":{
"shape":"ShouldRespectGracePeriod",
@ -3277,7 +3425,7 @@
},
"ProtectedFromScaleIn":{
"shape":"ProtectedFromScaleIn",
"documentation":"<p>Indicates whether the instance is protected from termination by Auto Scaling when scaling in.</p>"
"documentation":"<p>Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.</p>"
}
}
},
@ -3323,7 +3471,7 @@
"documentation":"<p>The reason that the process was suspended.</p>"
}
},
"documentation":"<p>Describes an Auto Scaling process that has been suspended. For more information, see <a>ProcessType</a>.</p>"
"documentation":"<p>Describes an automatic scaling process that has been suspended. For more information, see <a>ProcessType</a>.</p>"
},
"SuspendedProcesses":{
"type":"list",
@ -3494,7 +3642,7 @@
},
"DefaultCooldown":{
"shape":"Cooldown",
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"AvailabilityZones":{
"shape":"AvailabilityZones",
@ -3506,7 +3654,7 @@
},
"HealthCheckGracePeriod":{
"shape":"HealthCheckGracePeriod",
"documentation":"<p>The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/healthcheck.html\">Health Checks</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html\">Health Checks</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"PlacementGroup":{
"shape":"XmlStringMaxLen255",
@ -3514,11 +3662,11 @@
},
"VPCZoneIdentifier":{
"shape":"XmlStringMaxLen2047",
"documentation":"<p>The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.</p> <p>When you specify <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, ensure that the subnets' Availability Zones match the values you specify for <code>AvailabilityZones</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.</p> <p>When you specify <code>VPCZoneIdentifier</code> with <code>AvailabilityZones</code>, ensure that the subnets' Availability Zones match the values you specify for <code>AvailabilityZones</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"TerminationPolicies":{
"shape":"TerminationPolicies",
"documentation":"<p>A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
"documentation":"<p>A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html\">Controlling Which Instances Auto Scaling Terminates During Scale In</a> in the <i>Auto Scaling User Guide</i>.</p>"
},
"NewInstancesProtectedFromScaleIn":{
"shape":"InstanceProtected",

99
botocore/data/ce/2017-10-25/service-2.json
View file

@ -329,6 +329,62 @@
},
"documentation":"<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>"
},
"ESInstanceDetails":{
"type":"structure",
"members":{
"InstanceClass":{
"shape":"GenericString",
"documentation":"<p>The class of instance that AWS recommends.</p>"
},
"InstanceSize":{
"shape":"GenericString",
"documentation":"<p>The size of instance that AWS recommends.</p>"
},
"Region":{
"shape":"GenericString",
"documentation":"<p>The AWS Region of the recommended reservation.</p>"
},
"CurrentGeneration":{
"shape":"GenericBoolean",
"documentation":"<p>Whether the recommendation is for a current generation instance.</p>"
},
"SizeFlexEligible":{
"shape":"GenericBoolean",
"documentation":"<p>Whether the recommended reservation is size flexible.</p>"
}
},
"documentation":"<p>Details about the ES instances that AWS recommends that you purchase.</p>"
},
"ElastiCacheInstanceDetails":{
"type":"structure",
"members":{
"Family":{
"shape":"GenericString",
"documentation":"<p>The instance family of the recommended reservation.</p>"
},
"NodeType":{
"shape":"GenericString",
"documentation":"<p>The type of node that AWS recommends.</p>"
},
"Region":{
"shape":"GenericString",
"documentation":"<p>The AWS Region of the recommended reservation.</p>"
},
"ProductDescription":{
"shape":"GenericString",
"documentation":"<p>The description of the recommended reservation.</p>"
},
"CurrentGeneration":{
"shape":"GenericBoolean",
"documentation":"<p>Whether the recommendation is for a current generation instance.</p>"
},
"SizeFlexEligible":{
"shape":"GenericBoolean",
"documentation":"<p>Whether the recommended reservation is size flexible.</p>"
}
},
"documentation":"<p>Details about the ElastiCache instances that AWS recommends that you purchase.</p>"
},
"Entity":{"type":"string"},
"ErrorMessage":{"type":"string"},
"Estimated":{"type":"boolean"},
@ -722,6 +778,18 @@
"RDSInstanceDetails":{
"shape":"RDSInstanceDetails",
"documentation":"<p>The RDS instances that AWS recommends that you purchase.</p>"
},
"RedshiftInstanceDetails":{
"shape":"RedshiftInstanceDetails",
"documentation":"<p>The Amazon Redshift instances that AWS recommends that you purchase.</p>"
},
"ElastiCacheInstanceDetails":{
"shape":"ElastiCacheInstanceDetails",
"documentation":"<p>The ElastiCache instances that AWS recommends that you purchase.</p>"
},
"ESInstanceDetails":{
"shape":"ESInstanceDetails",
"documentation":"<p>The Amazon ES instances that AWS recommends that you purchase.</p>"
}
},
"documentation":"<p>Details about the instances that AWS recommends that you purchase.</p>"
@ -802,7 +870,10 @@
"enum":[
"NO_UPFRONT",
"PARTIAL_UPFRONT",
"ALL_UPFRONT"
"ALL_UPFRONT",
"LIGHT_UTILIZATION",
"MEDIUM_UTILIZATION",
"HEAVY_UTILIZATION"
]
},
"PurchasedHours":{"type":"string"},
@ -848,6 +919,32 @@
},
"documentation":"<p>Details about the RDS instances that AWS recommends that you purchase.</p>"
},
"RedshiftInstanceDetails":{
"type":"structure",
"members":{
"Family":{
"shape":"GenericString",
"documentation":"<p>The instance family of the recommended reservation.</p>"
},
"NodeType":{
"shape":"GenericString",
"documentation":"<p>The type of node that AWS recommends.</p>"
},
"Region":{
"shape":"GenericString",
"documentation":"<p>The AWS Region of the recommended reservation.</p>"
},
"CurrentGeneration":{
"shape":"GenericBoolean",
"documentation":"<p>Whether the recommendation is for a current generation instance.</p>"
},
"SizeFlexEligible":{
"shape":"GenericBoolean",
"documentation":"<p>Whether the recommended reservation is size flexible.</p>"
}
},
"documentation":"<p>Details about the Amazon Redshift instances that AWS recommends that you purchase.</p>"
},
"RequestChangedException":{
"type":"structure",
"members":{

5
botocore/data/cloudfront/2018-06-18/examples-1.json Normal file
View file

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

32
botocore/data/cloudfront/2018-06-18/paginators-1.json Normal file
View file

@ -0,0 +1,32 @@
{
"pagination": {
"ListCloudFrontOriginAccessIdentities": {
"input_token": "Marker",
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
"limit_key": "MaxItems",
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
"result_key": "CloudFrontOriginAccessIdentityList.Items"
},
"ListDistributions": {
"input_token": "Marker",
"output_token": "DistributionList.NextMarker",
"limit_key": "MaxItems",
"more_results": "DistributionList.IsTruncated",
"result_key": "DistributionList.Items"
},
"ListInvalidations": {
"input_token": "Marker",
"output_token": "InvalidationList.NextMarker",
"limit_key": "MaxItems",
"more_results": "InvalidationList.IsTruncated",
"result_key": "InvalidationList.Items"
},
"ListStreamingDistributions": {
"input_token": "Marker",
"output_token": "StreamingDistributionList.NextMarker",
"limit_key": "MaxItems",
"more_results": "StreamingDistributionList.IsTruncated",
"result_key": "StreamingDistributionList.Items"
}
}
}

5197
botocore/data/cloudfront/2018-06-18/service-2.json Normal file
View file

@ -0,0 +1,5197 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-06-18",
"endpointPrefix":"cloudfront",
"globalEndpoint":"cloudfront.amazonaws.com",
"protocol":"rest-xml",
"serviceAbbreviation":"CloudFront",
"serviceFullName":"Amazon CloudFront",
"serviceId":"CloudFront",
"signatureVersion":"v4",
"uid":"cloudfront-2018-06-18"
},
"operations":{
"CreateCloudFrontOriginAccessIdentity":{
"name":"CreateCloudFrontOriginAccessIdentity2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/origin-access-identity/cloudfront",
"responseCode":201
},
"input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"},
"output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"},
"errors":[
{"shape":"CloudFrontOriginAccessIdentityAlreadyExists"},
{"shape":"MissingBody"},
{"shape":"TooManyCloudFrontOriginAccessIdentities"},
{"shape":"InvalidArgument"},
{"shape":"InconsistentQuantities"}
],
"documentation":"<p>Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"CreateDistribution":{
"name":"CreateDistribution2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/distribution",
"responseCode":201
},
"input":{"shape":"CreateDistributionRequest"},
"output":{"shape":"CreateDistributionResult"},
"errors":[
{"shape":"CNAMEAlreadyExists"},
{"shape":"DistributionAlreadyExists"},
{"shape":"InvalidOrigin"},
{"shape":"InvalidOriginAccessIdentity"},
{"shape":"AccessDenied"},
{"shape":"TooManyTrustedSigners"},
{"shape":"TrustedSignerDoesNotExist"},
{"shape":"InvalidViewerCertificate"},
{"shape":"InvalidMinimumProtocolVersion"},
{"shape":"MissingBody"},
{"shape":"TooManyDistributionCNAMEs"},
{"shape":"TooManyDistributions"},
{"shape":"InvalidDefaultRootObject"},
{"shape":"InvalidRelativePath"},
{"shape":"InvalidErrorCode"},
{"shape":"InvalidResponseCode"},
{"shape":"InvalidArgument"},
{"shape":"InvalidRequiredProtocol"},
{"shape":"NoSuchOrigin"},
{"shape":"TooManyOrigins"},
{"shape":"TooManyCacheBehaviors"},
{"shape":"TooManyCookieNamesInWhiteList"},
{"shape":"InvalidForwardCookies"},
{"shape":"TooManyHeadersInForwardedValues"},
{"shape":"InvalidHeadersForS3Origin"},
{"shape":"InconsistentQuantities"},
{"shape":"TooManyCertificates"},
{"shape":"InvalidLocationCode"},
{"shape":"InvalidGeoRestrictionParameter"},
{"shape":"InvalidProtocolSettings"},
{"shape":"InvalidTTLOrder"},
{"shape":"InvalidWebACLId"},
{"shape":"TooManyOriginCustomHeaders"},
{"shape":"TooManyQueryStringParameters"},
{"shape":"InvalidQueryStringParameters"},
{"shape":"TooManyDistributionsWithLambdaAssociations"},
{"shape":"TooManyLambdaFunctionAssociations"},
{"shape":"InvalidLambdaFunctionAssociation"},
{"shape":"InvalidOriginReadTimeout"},
{"shape":"InvalidOriginKeepaliveTimeout"},
{"shape":"NoSuchFieldLevelEncryptionConfig"},
{"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"},
{"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"}
],
"documentation":"<p>Creates a new web distribution. Send a <code>POST</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code> resource.</p>"
},
"CreateDistributionWithTags":{
"name":"CreateDistributionWithTags2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/distribution?WithTags",
"responseCode":201
},
"input":{"shape":"CreateDistributionWithTagsRequest"},
"output":{"shape":"CreateDistributionWithTagsResult"},
"errors":[
{"shape":"CNAMEAlreadyExists"},
{"shape":"DistributionAlreadyExists"},
{"shape":"InvalidOrigin"},
{"shape":"InvalidOriginAccessIdentity"},
{"shape":"AccessDenied"},
{"shape":"TooManyTrustedSigners"},
{"shape":"TrustedSignerDoesNotExist"},
{"shape":"InvalidViewerCertificate"},
{"shape":"InvalidMinimumProtocolVersion"},
{"shape":"MissingBody"},
{"shape":"TooManyDistributionCNAMEs"},
{"shape":"TooManyDistributions"},
{"shape":"InvalidDefaultRootObject"},
{"shape":"InvalidRelativePath"},
{"shape":"InvalidErrorCode"},
{"shape":"InvalidResponseCode"},
{"shape":"InvalidArgument"},
{"shape":"InvalidRequiredProtocol"},
{"shape":"NoSuchOrigin"},
{"shape":"TooManyOrigins"},
{"shape":"TooManyCacheBehaviors"},
{"shape":"TooManyCookieNamesInWhiteList"},
{"shape":"InvalidForwardCookies"},
{"shape":"TooManyHeadersInForwardedValues"},
{"shape":"InvalidHeadersForS3Origin"},
{"shape":"InconsistentQuantities"},
{"shape":"TooManyCertificates"},
{"shape":"InvalidLocationCode"},
{"shape":"InvalidGeoRestrictionParameter"},
{"shape":"InvalidProtocolSettings"},
{"shape":"InvalidTTLOrder"},
{"shape":"InvalidWebACLId"},
{"shape":"TooManyOriginCustomHeaders"},
{"shape":"InvalidTagging"},
{"shape":"TooManyQueryStringParameters"},
{"shape":"InvalidQueryStringParameters"},
{"shape":"TooManyDistributionsWithLambdaAssociations"},
{"shape":"TooManyLambdaFunctionAssociations"},
{"shape":"InvalidLambdaFunctionAssociation"},
{"shape":"InvalidOriginReadTimeout"},
{"shape":"InvalidOriginKeepaliveTimeout"},
{"shape":"NoSuchFieldLevelEncryptionConfig"},
{"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"},
{"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"}
],
"documentation":"<p>Create a new distribution with tags.</p>"
},
"CreateFieldLevelEncryptionConfig":{
"name":"CreateFieldLevelEncryptionConfig2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/field-level-encryption",
"responseCode":201
},
"input":{"shape":"CreateFieldLevelEncryptionConfigRequest"},
"output":{"shape":"CreateFieldLevelEncryptionConfigResult"},
"errors":[
{"shape":"InconsistentQuantities"},
{"shape":"InvalidArgument"},
{"shape":"NoSuchFieldLevelEncryptionProfile"},
{"shape":"FieldLevelEncryptionConfigAlreadyExists"},
{"shape":"TooManyFieldLevelEncryptionConfigs"},
{"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"},
{"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"},
{"shape":"QueryArgProfileEmpty"}
],
"documentation":"<p>Create a new field-level encryption configuration.</p>"
},
"CreateFieldLevelEncryptionProfile":{
"name":"CreateFieldLevelEncryptionProfile2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/field-level-encryption-profile",
"responseCode":201
},
"input":{"shape":"CreateFieldLevelEncryptionProfileRequest"},
"output":{"shape":"CreateFieldLevelEncryptionProfileResult"},
"errors":[
{"shape":"InconsistentQuantities"},
{"shape":"InvalidArgument"},
{"shape":"NoSuchPublicKey"},
{"shape":"FieldLevelEncryptionProfileAlreadyExists"},
{"shape":"FieldLevelEncryptionProfileSizeExceeded"},
{"shape":"TooManyFieldLevelEncryptionProfiles"},
{"shape":"TooManyFieldLevelEncryptionEncryptionEntities"},
{"shape":"TooManyFieldLevelEncryptionFieldPatterns"}
],
"documentation":"<p>Create a field-level encryption profile.</p>"
},
"CreateInvalidation":{
"name":"CreateInvalidation2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/distribution/{DistributionId}/invalidation",
"responseCode":201
},
"input":{"shape":"CreateInvalidationRequest"},
"output":{"shape":"CreateInvalidationResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"MissingBody"},
{"shape":"InvalidArgument"},
{"shape":"NoSuchDistribution"},
{"shape":"BatchTooLarge"},
{"shape":"TooManyInvalidationsInProgress"},
{"shape":"InconsistentQuantities"}
],
"documentation":"<p>Create a new invalidation. </p>"
},
"CreatePublicKey":{
"name":"CreatePublicKey2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/public-key",
"responseCode":201
},
"input":{"shape":"CreatePublicKeyRequest"},
"output":{"shape":"CreatePublicKeyResult"},
"errors":[
{"shape":"PublicKeyAlreadyExists"},
{"shape":"InvalidArgument"},
{"shape":"TooManyPublicKeys"}
],
"documentation":"<p>Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.</p>"
},
"CreateStreamingDistribution":{
"name":"CreateStreamingDistribution2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/streaming-distribution",
"responseCode":201
},
"input":{"shape":"CreateStreamingDistributionRequest"},
"output":{"shape":"CreateStreamingDistributionResult"},
"errors":[
{"shape":"CNAMEAlreadyExists"},
{"shape":"StreamingDistributionAlreadyExists"},
{"shape":"InvalidOrigin"},
{"shape":"InvalidOriginAccessIdentity"},
{"shape":"AccessDenied"},
{"shape":"TooManyTrustedSigners"},
{"shape":"TrustedSignerDoesNotExist"},
{"shape":"MissingBody"},
{"shape":"TooManyStreamingDistributionCNAMEs"},
{"shape":"TooManyStreamingDistributions"},
{"shape":"InvalidArgument"},
{"shape":"InconsistentQuantities"}
],
"documentation":"<p>Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP. </p> <p>To create a new web distribution, submit a <code>POST</code> request to the <i>CloudFront API version</i>/distribution resource. The request body must include a document with a <i>StreamingDistributionConfig</i> element. The response echoes the <code>StreamingDistributionConfig</code> element and returns other information about the RTMP distribution.</p> <p>To get the status of your request, use the <i>GET StreamingDistribution</i> API action. When the value of <code>Enabled</code> is <code>true</code> and the value of <code>Status</code> is <code>Deployed</code>, your distribution is ready. A distribution usually deploys in less than 15 minutes.</p> <p>For more information about web distributions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-rtmp.html\">Working with RTMP Distributions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <important> <p>Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the <code>Quantity</code> element and the number of values specified.</p> </important>"
},
"CreateStreamingDistributionWithTags":{
"name":"CreateStreamingDistributionWithTags2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/streaming-distribution?WithTags",
"responseCode":201
},
"input":{"shape":"CreateStreamingDistributionWithTagsRequest"},
"output":{"shape":"CreateStreamingDistributionWithTagsResult"},
"errors":[
{"shape":"CNAMEAlreadyExists"},
{"shape":"StreamingDistributionAlreadyExists"},
{"shape":"InvalidOrigin"},
{"shape":"InvalidOriginAccessIdentity"},
{"shape":"AccessDenied"},
{"shape":"TooManyTrustedSigners"},
{"shape":"TrustedSignerDoesNotExist"},
{"shape":"MissingBody"},
{"shape":"TooManyStreamingDistributionCNAMEs"},
{"shape":"TooManyStreamingDistributions"},
{"shape":"InvalidArgument"},
{"shape":"InconsistentQuantities"},
{"shape":"InvalidTagging"}
],
"documentation":"<p>Create a new streaming distribution with tags.</p>"
},
"DeleteCloudFrontOriginAccessIdentity":{
"name":"DeleteCloudFrontOriginAccessIdentity2018_06_18",
"http":{
"method":"DELETE",
"requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}",
"responseCode":204
},
"input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
{"shape":"PreconditionFailed"},
{"shape":"CloudFrontOriginAccessIdentityInUse"}
],
"documentation":"<p>Delete an origin access identity. </p>"
},
"DeleteDistribution":{
"name":"DeleteDistribution2018_06_18",
"http":{
"method":"DELETE",
"requestUri":"/2018-06-18/distribution/{Id}",
"responseCode":204
},
"input":{"shape":"DeleteDistributionRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"DistributionNotDisabled"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchDistribution"},
{"shape":"PreconditionFailed"}
],
"documentation":"<p>Delete a distribution. </p>"
},
"DeleteFieldLevelEncryptionConfig":{
"name":"DeleteFieldLevelEncryptionConfig2018_06_18",
"http":{
"method":"DELETE",
"requestUri":"/2018-06-18/field-level-encryption/{Id}",
"responseCode":204
},
"input":{"shape":"DeleteFieldLevelEncryptionConfigRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchFieldLevelEncryptionConfig"},
{"shape":"PreconditionFailed"},
{"shape":"FieldLevelEncryptionConfigInUse"}
],
"documentation":"<p>Remove a field-level encryption configuration.</p>"
},
"DeleteFieldLevelEncryptionProfile":{
"name":"DeleteFieldLevelEncryptionProfile2018_06_18",
"http":{
"method":"DELETE",
"requestUri":"/2018-06-18/field-level-encryption-profile/{Id}",
"responseCode":204
},
"input":{"shape":"DeleteFieldLevelEncryptionProfileRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchFieldLevelEncryptionProfile"},
{"shape":"PreconditionFailed"},
{"shape":"FieldLevelEncryptionProfileInUse"}
],
"documentation":"<p>Remove a field-level encryption profile.</p>"
},
"DeletePublicKey":{
"name":"DeletePublicKey2018_06_18",
"http":{
"method":"DELETE",
"requestUri":"/2018-06-18/public-key/{Id}",
"responseCode":204
},
"input":{"shape":"DeletePublicKeyRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"PublicKeyInUse"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchPublicKey"},
{"shape":"PreconditionFailed"}
],
"documentation":"<p>Remove a public key you previously added to CloudFront.</p>"
},
"DeleteStreamingDistribution":{
"name":"DeleteStreamingDistribution2018_06_18",
"http":{
"method":"DELETE",
"requestUri":"/2018-06-18/streaming-distribution/{Id}",
"responseCode":204
},
"input":{"shape":"DeleteStreamingDistributionRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"StreamingDistributionNotDisabled"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchStreamingDistribution"},
{"shape":"PreconditionFailed"}
],
"documentation":"<p>Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete an RTMP distribution using the CloudFront API</b>:</p> <ol> <li> <p>Disable the RTMP distribution.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution. </p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Streaming Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to your <code>DELETE Streaming Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"GetCloudFrontOriginAccessIdentity":{
"name":"GetCloudFrontOriginAccessIdentity2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}"
},
"input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"},
"output":{"shape":"GetCloudFrontOriginAccessIdentityResult"},
"errors":[
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Get the information about an origin access identity. </p>"
},
"GetCloudFrontOriginAccessIdentityConfig":{
"name":"GetCloudFrontOriginAccessIdentityConfig2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}/config"
},
"input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"},
"output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"},
"errors":[
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Get the configuration information about an origin access identity. </p>"
},
"GetDistribution":{
"name":"GetDistribution2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/distribution/{Id}"
},
"input":{"shape":"GetDistributionRequest"},
"output":{"shape":"GetDistributionResult"},
"errors":[
{"shape":"NoSuchDistribution"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Get the information about a distribution. </p>"
},
"GetDistributionConfig":{
"name":"GetDistributionConfig2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/distribution/{Id}/config"
},
"input":{"shape":"GetDistributionConfigRequest"},
"output":{"shape":"GetDistributionConfigResult"},
"errors":[
{"shape":"NoSuchDistribution"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Get the configuration information about a distribution. </p>"
},
"GetFieldLevelEncryption":{
"name":"GetFieldLevelEncryption2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/field-level-encryption/{Id}"
},
"input":{"shape":"GetFieldLevelEncryptionRequest"},
"output":{"shape":"GetFieldLevelEncryptionResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"NoSuchFieldLevelEncryptionConfig"}
],
"documentation":"<p>Get the field-level encryption configuration information.</p>"
},
"GetFieldLevelEncryptionConfig":{
"name":"GetFieldLevelEncryptionConfig2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/field-level-encryption/{Id}/config"
},
"input":{"shape":"GetFieldLevelEncryptionConfigRequest"},
"output":{"shape":"GetFieldLevelEncryptionConfigResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"NoSuchFieldLevelEncryptionConfig"}
],
"documentation":"<p>Get the field-level encryption configuration information.</p>"
},
"GetFieldLevelEncryptionProfile":{
"name":"GetFieldLevelEncryptionProfile2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/field-level-encryption-profile/{Id}"
},
"input":{"shape":"GetFieldLevelEncryptionProfileRequest"},
"output":{"shape":"GetFieldLevelEncryptionProfileResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"NoSuchFieldLevelEncryptionProfile"}
],
"documentation":"<p>Get the field-level encryption profile information.</p>"
},
"GetFieldLevelEncryptionProfileConfig":{
"name":"GetFieldLevelEncryptionProfileConfig2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/field-level-encryption-profile/{Id}/config"
},
"input":{"shape":"GetFieldLevelEncryptionProfileConfigRequest"},
"output":{"shape":"GetFieldLevelEncryptionProfileConfigResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"NoSuchFieldLevelEncryptionProfile"}
],
"documentation":"<p>Get the field-level encryption profile configuration information.</p>"
},
"GetInvalidation":{
"name":"GetInvalidation2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/distribution/{DistributionId}/invalidation/{Id}"
},
"input":{"shape":"GetInvalidationRequest"},
"output":{"shape":"GetInvalidationResult"},
"errors":[
{"shape":"NoSuchInvalidation"},
{"shape":"NoSuchDistribution"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Get the information about an invalidation. </p>"
},
"GetPublicKey":{
"name":"GetPublicKey2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/public-key/{Id}"
},
"input":{"shape":"GetPublicKeyRequest"},
"output":{"shape":"GetPublicKeyResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"NoSuchPublicKey"}
],
"documentation":"<p>Get the public key information.</p>"
},
"GetPublicKeyConfig":{
"name":"GetPublicKeyConfig2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/public-key/{Id}/config"
},
"input":{"shape":"GetPublicKeyConfigRequest"},
"output":{"shape":"GetPublicKeyConfigResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"NoSuchPublicKey"}
],
"documentation":"<p>Return public key configuration informaation</p>"
},
"GetStreamingDistribution":{
"name":"GetStreamingDistribution2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/streaming-distribution/{Id}"
},
"input":{"shape":"GetStreamingDistributionRequest"},
"output":{"shape":"GetStreamingDistributionResult"},
"errors":[
{"shape":"NoSuchStreamingDistribution"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Gets information about a specified RTMP distribution, including the distribution configuration.</p>"
},
"GetStreamingDistributionConfig":{
"name":"GetStreamingDistributionConfig2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/streaming-distribution/{Id}/config"
},
"input":{"shape":"GetStreamingDistributionConfigRequest"},
"output":{"shape":"GetStreamingDistributionConfigResult"},
"errors":[
{"shape":"NoSuchStreamingDistribution"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Get the configuration information about a streaming distribution. </p>"
},
"ListCloudFrontOriginAccessIdentities":{
"name":"ListCloudFrontOriginAccessIdentities2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/origin-access-identity/cloudfront"
},
"input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"},
"output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"},
"errors":[
{"shape":"InvalidArgument"}
],
"documentation":"<p>Lists origin access identities.</p>"
},
"ListDistributions":{
"name":"ListDistributions2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/distribution"
},
"input":{"shape":"ListDistributionsRequest"},
"output":{"shape":"ListDistributionsResult"},
"errors":[
{"shape":"InvalidArgument"}
],
"documentation":"<p>List distributions. </p>"
},
"ListDistributionsByWebACLId":{
"name":"ListDistributionsByWebACLId2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/distributionsByWebACLId/{WebACLId}"
},
"input":{"shape":"ListDistributionsByWebACLIdRequest"},
"output":{"shape":"ListDistributionsByWebACLIdResult"},
"errors":[
{"shape":"InvalidArgument"},
{"shape":"InvalidWebACLId"}
],
"documentation":"<p>List the distributions that are associated with a specified AWS WAF web ACL. </p>"
},
"ListFieldLevelEncryptionConfigs":{
"name":"ListFieldLevelEncryptionConfigs2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/field-level-encryption"
},
"input":{"shape":"ListFieldLevelEncryptionConfigsRequest"},
"output":{"shape":"ListFieldLevelEncryptionConfigsResult"},
"errors":[
{"shape":"InvalidArgument"}
],
"documentation":"<p>List all field-level encryption configurations that have been created in CloudFront for this account.</p>"
},
"ListFieldLevelEncryptionProfiles":{
"name":"ListFieldLevelEncryptionProfiles2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/field-level-encryption-profile"
},
"input":{"shape":"ListFieldLevelEncryptionProfilesRequest"},
"output":{"shape":"ListFieldLevelEncryptionProfilesResult"},
"errors":[
{"shape":"InvalidArgument"}
],
"documentation":"<p>Request a list of field-level encryption profiles that have been created in CloudFront for this account.</p>"
},
"ListInvalidations":{
"name":"ListInvalidations2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/distribution/{DistributionId}/invalidation"
},
"input":{"shape":"ListInvalidationsRequest"},
"output":{"shape":"ListInvalidationsResult"},
"errors":[
{"shape":"InvalidArgument"},
{"shape":"NoSuchDistribution"},
{"shape":"AccessDenied"}
],
"documentation":"<p>Lists invalidation batches. </p>"
},
"ListPublicKeys":{
"name":"ListPublicKeys2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/public-key"
},
"input":{"shape":"ListPublicKeysRequest"},
"output":{"shape":"ListPublicKeysResult"},
"errors":[
{"shape":"InvalidArgument"}
],
"documentation":"<p>List all public keys that have been added to CloudFront for this account.</p>"
},
"ListStreamingDistributions":{
"name":"ListStreamingDistributions2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/streaming-distribution"
},
"input":{"shape":"ListStreamingDistributionsRequest"},
"output":{"shape":"ListStreamingDistributionsResult"},
"errors":[
{"shape":"InvalidArgument"}
],
"documentation":"<p>List streaming distributions. </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource2018_06_18",
"http":{
"method":"GET",
"requestUri":"/2018-06-18/tagging"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"InvalidArgument"},
{"shape":"InvalidTagging"},
{"shape":"NoSuchResource"}
],
"documentation":"<p>List tags for a CloudFront resource.</p>"
},
"TagResource":{
"name":"TagResource2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/tagging?Operation=Tag",
"responseCode":204
},
"input":{"shape":"TagResourceRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"InvalidArgument"},
{"shape":"InvalidTagging"},
{"shape":"NoSuchResource"}
],
"documentation":"<p>Add tags to a CloudFront resource.</p>"
},
"UntagResource":{
"name":"UntagResource2018_06_18",
"http":{
"method":"POST",
"requestUri":"/2018-06-18/tagging?Operation=Untag",
"responseCode":204
},
"input":{"shape":"UntagResourceRequest"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"InvalidArgument"},
{"shape":"InvalidTagging"},
{"shape":"NoSuchResource"}
],
"documentation":"<p>Remove tags from a CloudFront resource.</p>"
},
"UpdateCloudFrontOriginAccessIdentity":{
"name":"UpdateCloudFrontOriginAccessIdentity2018_06_18",
"http":{
"method":"PUT",
"requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}/config"
},
"input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"},
"output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"IllegalUpdate"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"MissingBody"},
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
{"shape":"PreconditionFailed"},
{"shape":"InvalidArgument"},
{"shape":"InconsistentQuantities"}
],
"documentation":"<p>Update an origin access identity. </p>"
},
"UpdateDistribution":{
"name":"UpdateDistribution2018_06_18",
"http":{
"method":"PUT",
"requestUri":"/2018-06-18/distribution/{Id}/config"
},
"input":{"shape":"UpdateDistributionRequest"},
"output":{"shape":"UpdateDistributionResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"CNAMEAlreadyExists"},
{"shape":"IllegalUpdate"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"MissingBody"},
{"shape":"NoSuchDistribution"},
{"shape":"PreconditionFailed"},
{"shape":"TooManyDistributionCNAMEs"},
{"shape":"InvalidDefaultRootObject"},
{"shape":"InvalidRelativePath"},
{"shape":"InvalidErrorCode"},
{"shape":"InvalidResponseCode"},
{"shape":"InvalidArgument"},
{"shape":"InvalidOriginAccessIdentity"},
{"shape":"TooManyTrustedSigners"},
{"shape":"TrustedSignerDoesNotExist"},
{"shape":"InvalidViewerCertificate"},
{"shape":"InvalidMinimumProtocolVersion"},
{"shape":"InvalidRequiredProtocol"},
{"shape":"NoSuchOrigin"},
{"shape":"TooManyOrigins"},
{"shape":"TooManyCacheBehaviors"},
{"shape":"TooManyCookieNamesInWhiteList"},
{"shape":"InvalidForwardCookies"},
{"shape":"TooManyHeadersInForwardedValues"},
{"shape":"InvalidHeadersForS3Origin"},
{"shape":"InconsistentQuantities"},
{"shape":"TooManyCertificates"},
{"shape":"InvalidLocationCode"},
{"shape":"InvalidGeoRestrictionParameter"},
{"shape":"InvalidTTLOrder"},
{"shape":"InvalidWebACLId"},
{"shape":"TooManyOriginCustomHeaders"},
{"shape":"TooManyQueryStringParameters"},
{"shape":"InvalidQueryStringParameters"},
{"shape":"TooManyDistributionsWithLambdaAssociations"},
{"shape":"TooManyLambdaFunctionAssociations"},
{"shape":"InvalidLambdaFunctionAssociation"},
{"shape":"InvalidOriginReadTimeout"},
{"shape":"InvalidOriginKeepaliveTimeout"},
{"shape":"NoSuchFieldLevelEncryptionConfig"},
{"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"},
{"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"}
],
"documentation":"<p>Updates the configuration for a web distribution. Perform the following steps.</p> <p>For information about updating a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html\">Creating or Updating a Web Distribution Using the CloudFront Console </a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p> <b>To update a web distribution using the CloudFront API</b> </p> <ol> <li> <p>Submit a <a>GetDistributionConfig</a> request to get the current configuration and an <code>Etag</code> header for the distribution.</p> <note> <p>If you update the distribution again, you need to get a new <code>Etag</code> header.</p> </note> </li> <li> <p>Update the XML document that was returned in the response to your <code>GetDistributionConfig</code> request to include the desired changes. You can't change the value of <code>CallerReference</code>. If you try to change this value, CloudFront returns an <code>IllegalUpdate</code> error. Note that you must strip out the ETag parameter that is returned.</p> <important> <p>The new configuration replaces the existing configuration; the values that you specify in an <code>UpdateDistribution</code> request are not merged into the existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, <code>CNAME</code>), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding <code>Quantity</code> element.</p> </important> </li> <li> <p>Submit an <code>UpdateDistribution</code> request to update the configuration for your distribution:</p> <ul> <li> <p>In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a <code>DistributionConfig</code> element.</p> </li> <li> <p>Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GetDistributionConfig</code> request in Step 1.</p> </li> </ul> </li> <li> <p>Review the response to the <code>UpdateDistribution</code> request to confirm that the configuration was successfully updated.</p> </li> <li> <p>Optional: Submit a <a>GetDistribution</a> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> <important> <p>Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a distribution. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the <code>Quantity</code> element and the number of values you're actually specifying.</p> </important> </li> </ol>"
},
"UpdateFieldLevelEncryptionConfig":{
"name":"UpdateFieldLevelEncryptionConfig2018_06_18",
"http":{
"method":"PUT",
"requestUri":"/2018-06-18/field-level-encryption/{Id}/config"
},
"input":{"shape":"UpdateFieldLevelEncryptionConfigRequest"},
"output":{"shape":"UpdateFieldLevelEncryptionConfigResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"IllegalUpdate"},
{"shape":"InconsistentQuantities"},
{"shape":"InvalidArgument"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchFieldLevelEncryptionProfile"},
{"shape":"NoSuchFieldLevelEncryptionConfig"},
{"shape":"PreconditionFailed"},
{"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"},
{"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"},
{"shape":"QueryArgProfileEmpty"}
],
"documentation":"<p>Update a field-level encryption configuration. </p>"
},
"UpdateFieldLevelEncryptionProfile":{
"name":"UpdateFieldLevelEncryptionProfile2018_06_18",
"http":{
"method":"PUT",
"requestUri":"/2018-06-18/field-level-encryption-profile/{Id}/config"
},
"input":{"shape":"UpdateFieldLevelEncryptionProfileRequest"},
"output":{"shape":"UpdateFieldLevelEncryptionProfileResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"FieldLevelEncryptionProfileAlreadyExists"},
{"shape":"IllegalUpdate"},
{"shape":"InconsistentQuantities"},
{"shape":"InvalidArgument"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"NoSuchPublicKey"},
{"shape":"NoSuchFieldLevelEncryptionProfile"},
{"shape":"PreconditionFailed"},
{"shape":"FieldLevelEncryptionProfileSizeExceeded"},
{"shape":"TooManyFieldLevelEncryptionEncryptionEntities"},
{"shape":"TooManyFieldLevelEncryptionFieldPatterns"}
],
"documentation":"<p>Update a field-level encryption profile. </p>"
},
"UpdatePublicKey":{
"name":"UpdatePublicKey2018_06_18",
"http":{
"method":"PUT",
"requestUri":"/2018-06-18/public-key/{Id}/config"
},
"input":{"shape":"UpdatePublicKeyRequest"},
"output":{"shape":"UpdatePublicKeyResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"CannotChangeImmutablePublicKeyFields"},
{"shape":"InvalidArgument"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"IllegalUpdate"},
{"shape":"NoSuchPublicKey"},
{"shape":"PreconditionFailed"}
],
"documentation":"<p>Update public key information. Note that the only value you can change is the comment.</p>"
},
"UpdateStreamingDistribution":{
"name":"UpdateStreamingDistribution2018_06_18",
"http":{
"method":"PUT",
"requestUri":"/2018-06-18/streaming-distribution/{Id}/config"
},
"input":{"shape":"UpdateStreamingDistributionRequest"},
"output":{"shape":"UpdateStreamingDistributionResult"},
"errors":[
{"shape":"AccessDenied"},
{"shape":"CNAMEAlreadyExists"},
{"shape":"IllegalUpdate"},
{"shape":"InvalidIfMatchVersion"},
{"shape":"MissingBody"},
{"shape":"NoSuchStreamingDistribution"},
{"shape":"PreconditionFailed"},
{"shape":"TooManyStreamingDistributionCNAMEs"},
{"shape":"InvalidArgument"},
{"shape":"InvalidOriginAccessIdentity"},
{"shape":"TooManyTrustedSigners"},
{"shape":"TrustedSignerDoesNotExist"},
{"shape":"InconsistentQuantities"}
],
"documentation":"<p>Update a streaming distribution. </p>"
}
},
"shapes":{
"AccessDenied":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Access denied.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"ActiveTrustedSigners":{
"type":"structure",
"required":[
"Enabled",
"Quantity"
],
"members":{
"Enabled":{
"shape":"boolean",
"documentation":"<p>Enabled is <code>true</code> if any of the AWS accounts listed in the <code>TrustedSigners</code> complex type for this RTMP distribution have active CloudFront key pairs. If not, <code>Enabled</code> is <code>false</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>A complex type that contains one <code>Signer</code> complex type for each trusted signer specified in the <code>TrustedSigners</code> complex type.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
},
"Items":{
"shape":"SignerList",
"documentation":"<p>A complex type that contains one <code>Signer</code> complex type for each trusted signer that is specified in the <code>TrustedSigners</code> complex type.</p> <p>For more information, see <a>ActiveTrustedSigners</a>. </p>"
}
},
"documentation":"<p>A complex type that lists the AWS accounts, if any, that you included in the <code>TrustedSigners</code> complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.</p> <p>The <code>Signer</code> complex type lists the AWS account number of the trusted signer or <code>self</code> if the signer is the AWS account that created the distribution. The <code>Signer</code> element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create signed URLs. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"AliasList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"CNAME"
}
},
"Aliases":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of CNAME aliases, if any, that you want to associate with this distribution.</p>"
},
"Items":{
"shape":"AliasList",
"documentation":"<p>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</p>"
}
},
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. </p>"
},
"AllowedMethods":{
"type":"structure",
"required":[
"Quantity",
"Items"
],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</p>"
},
"Items":{
"shape":"MethodsList",
"documentation":"<p>A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.</p>"
},
"CachedMethods":{"shape":"CachedMethods"}
},
"documentation":"<p>A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:</p> <ul> <li> <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> <li> <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests.</p> </li> </ul> <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.</p>"
},
"AwsAccountNumberList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"AwsAccountNumber"
}
},
"BatchTooLarge":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":413},
"exception":true
},
"CNAMEAlreadyExists":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"CacheBehavior":{
"type":"structure",
"required":[
"PathPattern",
"TargetOriginId",
"ForwardedValues",
"TrustedSigners",
"ViewerProtocolPolicy",
"MinTTL"
],
"members":{
"PathPattern":{
"shape":"string",
"documentation":"<p>The pattern (for example, <code>images/*.jpg</code>) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.</p> <note> <p>You can optionally include a slash (<code>/</code>) at the beginning of the path pattern. For example, <code>/images/*.jpg</code>. CloudFront behavior is the same with or without the leading <code>/</code>.</p> </note> <p>The path pattern for the default cache behavior is <code>*</code> and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern\">Path Pattern</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>"
},
"TargetOriginId":{
"shape":"string",
"documentation":"<p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.</p>"
},
"ForwardedValues":{
"shape":"ForwardedValues",
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
},
"TrustedSigners":{
"shape":"TrustedSigners",
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
},
"ViewerProtocolPolicy":{
"shape":"ViewerProtocolPolicy",
"documentation":"<p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. </p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). </p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>"
},
"MinTTL":{
"shape":"long",
"documentation":"<p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>"
},
"AllowedMethods":{"shape":"AllowedMethods"},
"SmoothStreaming":{
"shape":"boolean",
"documentation":"<p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>"
},
"DefaultTTL":{
"shape":"long",
"documentation":"<p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"MaxTTL":{
"shape":"long",
"documentation":"<p>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"Compress":{
"shape":"boolean",
"documentation":"<p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"LambdaFunctionAssociations":{
"shape":"LambdaFunctionAssociations",
"documentation":"<p>A complex type that contains zero or more Lambda function associations for a cache behavior.</p>"
},
"FieldLevelEncryptionId":{
"shape":"string",
"documentation":"<p>The value of <code>ID</code> for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.</p>"
}
},
"documentation":"<p>A complex type that describes how CloudFront processes requests.</p> <p>You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.</p> <p>For the current limit on the number of cache behaviors that you can add to a distribution, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p> <p>If you don't want to specify any cache behaviors, include only an empty <code>CacheBehaviors</code> element. Don't include an empty <code>CacheBehavior</code> element, or CloudFront returns a <code>MalformedXML</code> error.</p> <p>To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty <code>CacheBehaviors</code> element.</p> <p>To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.</p> <p>For more information about cache behaviors, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behaviors</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"CacheBehaviorList":{
"type":"list",
"member":{
"shape":"CacheBehavior",
"locationName":"CacheBehavior"
}
},
"CacheBehaviors":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of cache behaviors for this distribution. </p>"
},
"Items":{
"shape":"CacheBehaviorList",
"documentation":"<p>Optional: A complex type that contains cache behaviors for this distribution. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
}
},
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>"
},
"CachedMethods":{
"type":"structure",
"required":[
"Quantity",
"Items"
],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of HTTP methods for which you want CloudFront to cache responses. Valid values are <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code> requests) and <code>3</code> (for caching responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests).</p>"
},
"Items":{
"shape":"MethodsList",
"documentation":"<p>A complex type that contains the HTTP methods that you want CloudFront to cache responses to.</p>"
}
},
"documentation":"<p>A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:</p> <ul> <li> <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> </ul> <p>If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. </p>"
},
"CannotChangeImmutablePublicKeyFields":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>You can't change the value of a public key.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"CertificateSource":{
"type":"string",
"enum":[
"cloudfront",
"iam",
"acm"
]
},
"CloudFrontOriginAccessIdentity":{
"type":"structure",
"required":[
"Id",
"S3CanonicalUserId"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The ID for the origin access identity, for example, <code>E74FTE3AJFJ256A</code>. </p>"
},
"S3CanonicalUserId":{
"shape":"string",
"documentation":"<p>The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. </p>"
},
"CloudFrontOriginAccessIdentityConfig":{
"shape":"CloudFrontOriginAccessIdentityConfig",
"documentation":"<p>The current configuration information for the identity. </p>"
}
},
"documentation":"<p>CloudFront origin access identity.</p>"
},
"CloudFrontOriginAccessIdentityAlreadyExists":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>",
"error":{"httpStatusCode":409},
"exception":true
},
"CloudFrontOriginAccessIdentityConfig":{
"type":"structure",
"required":[
"CallerReference",
"Comment"
],
"members":{
"CallerReference":{
"shape":"string",
"documentation":"<p>A unique number that ensures the request can't be replayed.</p> <p>If the <code>CallerReference</code> is new (no matter the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</p> <p>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. </p> <p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>Any comments you want to include about the origin access identity. </p>"
}
},
"documentation":"<p>Origin access identity configuration. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/CloudFront/identity ID/config</code> resource. </p>"
},
"CloudFrontOriginAccessIdentityInUse":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"CloudFrontOriginAccessIdentityList":{
"type":"structure",
"required":[
"Marker",
"MaxItems",
"IsTruncated",
"Quantity"
],
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page). </p>"
},
"NextMarker":{
"shape":"string",
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your origin access identities where they left off. </p>"
},
"MaxItems":{
"shape":"integer",
"documentation":"<p>The maximum number of origin access identities you want in the response body. </p>"
},
"IsTruncated":{
"shape":"boolean",
"documentation":"<p>A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more items in the list.</p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of CloudFront origin access identities that were created by the current AWS account. </p>"
},
"Items":{
"shape":"CloudFrontOriginAccessIdentitySummaryList",
"documentation":"<p>A complex type that contains one <code>CloudFrontOriginAccessIdentitySummary</code> element for each origin access identity that was created by the current AWS account.</p>"
}
},
"documentation":"<p>Lists the origin access identities for CloudFront.Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/origin-access-identity/cloudfront</code> resource. The response includes a <code>CloudFrontOriginAccessIdentityList</code> element with zero or more <code>CloudFrontOriginAccessIdentitySummary</code> child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>"
},
"CloudFrontOriginAccessIdentitySummary":{
"type":"structure",
"required":[
"Id",
"S3CanonicalUserId",
"Comment"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The ID for the origin access identity. For example: <code>E74FTE3AJFJ256A</code>.</p>"
},
"S3CanonicalUserId":{
"shape":"string",
"documentation":"<p>The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>The comment for this origin access identity, as originally specified when created.</p>"
}
},
"documentation":"<p>Summary of the information about a CloudFront origin access identity.</p>"
},
"CloudFrontOriginAccessIdentitySummaryList":{
"type":"list",
"member":{
"shape":"CloudFrontOriginAccessIdentitySummary",
"locationName":"CloudFrontOriginAccessIdentitySummary"
}
},
"ContentTypeProfile":{
"type":"structure",
"required":[
"Format",
"ContentType"
],
"members":{
"Format":{
"shape":"Format",
"documentation":"<p>The format for a field-level encryption content type-profile mapping. </p>"
},
"ProfileId":{
"shape":"string",
"documentation":"<p>The profile ID for a field-level encryption content type-profile mapping. </p>"
},
"ContentType":{
"shape":"string",
"documentation":"<p>The content type for a field-level encryption content type-profile mapping. </p>"
}
},
"documentation":"<p>A field-level encryption content type profile. </p>"
},
"ContentTypeProfileConfig":{
"type":"structure",
"required":["ForwardWhenContentTypeIsUnknown"],
"members":{
"ForwardWhenContentTypeIsUnknown":{
"shape":"boolean",
"documentation":"<p>The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown. </p>"
},
"ContentTypeProfiles":{
"shape":"ContentTypeProfiles",
"documentation":"<p>The configuration for a field-level encryption content type-profile. </p>"
}
},
"documentation":"<p>The configuration for a field-level encryption content type-profile mapping. </p>"
},
"ContentTypeProfileList":{
"type":"list",
"member":{
"shape":"ContentTypeProfile",
"locationName":"ContentTypeProfile"
}
},
"ContentTypeProfiles":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of field-level encryption content type-profile mappings. </p>"
},
"Items":{
"shape":"ContentTypeProfileList",
"documentation":"<p>Items in a field-level encryption content type-profile mapping. </p>"
}
},
"documentation":"<p>Field-level encryption content type-profile. </p>"
},
"CookieNameList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"Name"
}
},
"CookieNames":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.</p>"
},
"Items":{
"shape":"CookieNameList",
"documentation":"<p>A complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior.</p>"
}
},
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"CookiePreference":{
"type":"structure",
"required":["Forward"],
"members":{
"Forward":{
"shape":"ItemSelection",
"documentation":"<p>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> complex type.</p> <p>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <code>Forward</code> element. </p>"
},
"WhitelistedNames":{
"shape":"CookieNames",
"documentation":"<p>Required if you specify <code>whitelist</code> for the value of <code>Forward:</code>. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.</p> <p>If you specify <code>all</code> or none for the value of <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of <code>Forward</code> from <code>whitelist</code> to all or none and you don't delete the <code>WhitelistedNames</code> element and its child elements, CloudFront deletes them automatically.</p> <p>For the current limit on the number of cookie names that you can whitelist for each cache behavior, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
}
},
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"CreateCloudFrontOriginAccessIdentityRequest":{
"type":"structure",
"required":["CloudFrontOriginAccessIdentityConfig"],
"members":{
"CloudFrontOriginAccessIdentityConfig":{
"shape":"CloudFrontOriginAccessIdentityConfig",
"documentation":"<p>The current configuration information for the identity.</p>",
"locationName":"CloudFrontOriginAccessIdentityConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p>The request to create a new origin access identity.</p>",
"payload":"CloudFrontOriginAccessIdentityConfig"
},
"CreateCloudFrontOriginAccessIdentityResult":{
"type":"structure",
"members":{
"CloudFrontOriginAccessIdentity":{
"shape":"CloudFrontOriginAccessIdentity",
"documentation":"<p>The origin access identity's information.</p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new origin access identity just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A</code>.</p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the origin access identity created.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"CloudFrontOriginAccessIdentity"
},
"CreateDistributionRequest":{
"type":"structure",
"required":["DistributionConfig"],
"members":{
"DistributionConfig":{
"shape":"DistributionConfig",
"documentation":"<p>The distribution's configuration information.</p>",
"locationName":"DistributionConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p>The request to create a new distribution.</p>",
"payload":"DistributionConfig"
},
"CreateDistributionResult":{
"type":"structure",
"members":{
"Distribution":{
"shape":"Distribution",
"documentation":"<p>The distribution's information.</p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>.</p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the distribution created.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"Distribution"
},
"CreateDistributionWithTagsRequest":{
"type":"structure",
"required":["DistributionConfigWithTags"],
"members":{
"DistributionConfigWithTags":{
"shape":"DistributionConfigWithTags",
"documentation":"<p>The distribution's configuration information. </p>",
"locationName":"DistributionConfigWithTags",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p>The request to create a new distribution with tags. </p>",
"payload":"DistributionConfigWithTags"
},
"CreateDistributionWithTagsResult":{
"type":"structure",
"members":{
"Distribution":{
"shape":"Distribution",
"documentation":"<p>The distribution's information. </p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>. </p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the distribution created.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request. </p>",
"payload":"Distribution"
},
"CreateFieldLevelEncryptionConfigRequest":{
"type":"structure",
"required":["FieldLevelEncryptionConfig"],
"members":{
"FieldLevelEncryptionConfig":{
"shape":"FieldLevelEncryptionConfig",
"documentation":"<p>The request to create a new field-level encryption configuration.</p>",
"locationName":"FieldLevelEncryptionConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"payload":"FieldLevelEncryptionConfig"
},
"CreateFieldLevelEncryptionConfigResult":{
"type":"structure",
"members":{
"FieldLevelEncryption":{
"shape":"FieldLevelEncryption",
"documentation":"<p>Returned when you create a new field-level encryption configuration.</p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new configuration resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5</code>.</p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the field level encryption configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryption"
},
"CreateFieldLevelEncryptionProfileRequest":{
"type":"structure",
"required":["FieldLevelEncryptionProfileConfig"],
"members":{
"FieldLevelEncryptionProfileConfig":{
"shape":"FieldLevelEncryptionProfileConfig",
"documentation":"<p>The request to create a field-level encryption profile.</p>",
"locationName":"FieldLevelEncryptionProfileConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"payload":"FieldLevelEncryptionProfileConfig"
},
"CreateFieldLevelEncryptionProfileResult":{
"type":"structure",
"members":{
"FieldLevelEncryptionProfile":{
"shape":"FieldLevelEncryptionProfile",
"documentation":"<p>Returned when you create a new field-level encryption profile.</p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new profile resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5</code>.</p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the field level encryption profile. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryptionProfile"
},
"CreateInvalidationRequest":{
"type":"structure",
"required":[
"DistributionId",
"InvalidationBatch"
],
"members":{
"DistributionId":{
"shape":"string",
"documentation":"<p>The distribution's id.</p>",
"location":"uri",
"locationName":"DistributionId"
},
"InvalidationBatch":{
"shape":"InvalidationBatch",
"documentation":"<p>The batch information for the invalidation.</p>",
"locationName":"InvalidationBatch",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p>The request to create an invalidation.</p>",
"payload":"InvalidationBatch"
},
"CreateInvalidationResult":{
"type":"structure",
"members":{
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the distribution and invalidation batch request, including the <code>Invalidation ID</code>.</p>",
"location":"header",
"locationName":"Location"
},
"Invalidation":{
"shape":"Invalidation",
"documentation":"<p>The invalidation's information.</p>"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"Invalidation"
},
"CreatePublicKeyRequest":{
"type":"structure",
"required":["PublicKeyConfig"],
"members":{
"PublicKeyConfig":{
"shape":"PublicKeyConfig",
"documentation":"<p>The request to add a public key to CloudFront.</p>",
"locationName":"PublicKeyConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"payload":"PublicKeyConfig"
},
"CreatePublicKeyResult":{
"type":"structure",
"members":{
"PublicKey":{
"shape":"PublicKey",
"documentation":"<p>Returned when you add a public key.</p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new public key resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5</code>.</p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the public key. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"PublicKey"
},
"CreateStreamingDistributionRequest":{
"type":"structure",
"required":["StreamingDistributionConfig"],
"members":{
"StreamingDistributionConfig":{
"shape":"StreamingDistributionConfig",
"documentation":"<p>The streaming distribution's configuration information.</p>",
"locationName":"StreamingDistributionConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p>The request to create a new streaming distribution.</p>",
"payload":"StreamingDistributionConfig"
},
"CreateStreamingDistributionResult":{
"type":"structure",
"members":{
"StreamingDistribution":{
"shape":"StreamingDistribution",
"documentation":"<p>The streaming distribution's information.</p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the streaming distribution created.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"StreamingDistribution"
},
"CreateStreamingDistributionWithTagsRequest":{
"type":"structure",
"required":["StreamingDistributionConfigWithTags"],
"members":{
"StreamingDistributionConfigWithTags":{
"shape":"StreamingDistributionConfigWithTags",
"documentation":"<p> The streaming distribution's configuration information. </p>",
"locationName":"StreamingDistributionConfigWithTags",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p>The request to create a new streaming distribution with tags.</p>",
"payload":"StreamingDistributionConfigWithTags"
},
"CreateStreamingDistributionWithTagsResult":{
"type":"structure",
"members":{
"StreamingDistribution":{
"shape":"StreamingDistribution",
"documentation":"<p>The streaming distribution's information. </p>"
},
"Location":{
"shape":"string",
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example:<code> https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
"location":"header",
"locationName":"Location"
},
"ETag":{
"shape":"string",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request. </p>",
"payload":"StreamingDistribution"
},
"CustomErrorResponse":{
"type":"structure",
"required":["ErrorCode"],
"members":{
"ErrorCode":{
"shape":"integer",
"documentation":"<p>The HTTP status code for which you want to specify a custom error page and/or a caching duration.</p>"
},
"ResponsePagePath":{
"shape":"string",
"documentation":"<p>The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by <code>ErrorCode</code>, for example, <code>/4xx-errors/403-forbidden.html</code>. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:</p> <ul> <li> <p>The value of <code>PathPattern</code> matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named <code>/4xx-errors</code>. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, <code>/4xx-errors/*</code>. </p> </li> <li> <p>The value of <code>TargetOriginId</code> specifies the value of the <code>ID</code> element for the origin that contains your custom error pages.</p> </li> </ul> <p>If you specify a value for <code>ResponsePagePath</code>, you must also specify a value for <code>ResponseCode</code>. If you don't want to specify a value, include an empty element, <code>&lt;ResponsePagePath&gt;</code>, in the XML document.</p> <p>We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.</p>"
},
"ResponseCode":{
"shape":"string",
"documentation":"<p>The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:</p> <ul> <li> <p>Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute <code>200</code>, the response typically won't be intercepted.</p> </li> <li> <p>If you don't care about distinguishing among different client errors or server errors, you can specify <code>400</code> or <code>500</code> as the <code>ResponseCode</code> for all 4xx or 5xx errors.</p> </li> <li> <p>You might want to return a <code>200</code> status code (OK) and static website so your customers don't know that your website is down.</p> </li> </ul> <p>If you specify a value for <code>ResponseCode</code>, you must also specify a value for <code>ResponsePagePath</code>. If you don't want to specify a value, include an empty element, <code>&lt;ResponseCode&gt;</code>, in the XML document.</p>"
},
"ErrorCachingMinTTL":{
"shape":"long",
"documentation":"<p>The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in <code>ErrorCode</code>. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.</p> <p>If you don't want to specify a value, include an empty element, <code>&lt;ErrorCachingMinTTL&gt;</code>, in the XML document.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"documentation":"<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. </p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"CustomErrorResponseList":{
"type":"list",
"member":{
"shape":"CustomErrorResponse",
"locationName":"CustomErrorResponse"
}
},
"CustomErrorResponses":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
},
"Items":{
"shape":"CustomErrorResponseList",
"documentation":"<p>A complex type that contains a <code>CustomErrorResponse</code> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </p>"
}
},
"documentation":"<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"CustomHeaders":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of custom headers, if any, for this distribution.</p>"
},
"Items":{
"shape":"OriginCustomHeadersList",
"documentation":"<p> <b>Optional</b>: A list that contains one <code>OriginCustomHeader</code> element for each custom header that you want CloudFront to forward to the origin. If Quantity is <code>0</code>, omit <code>Items</code>.</p>"
}
},
"documentation":"<p>A complex type that contains the list of Custom Headers for each origin. </p>"
},
"CustomOriginConfig":{
"type":"structure",
"required":[
"HTTPPort",
"HTTPSPort",
"OriginProtocolPolicy"
],
"members":{
"HTTPPort":{
"shape":"integer",
"documentation":"<p>The HTTP port the custom origin listens on.</p>"
},
"HTTPSPort":{
"shape":"integer",
"documentation":"<p>The HTTPS port the custom origin listens on.</p>"
},
"OriginProtocolPolicy":{
"shape":"OriginProtocolPolicy",
"documentation":"<p>The origin protocol policy to apply to your origin.</p>"
},
"OriginSslProtocols":{
"shape":"OriginSslProtocols",
"documentation":"<p>The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.</p>"
},
"OriginReadTimeout":{
"shape":"integer",
"documentation":"<p>You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.</p> <p>If you need to increase the maximum time limit, contact the <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support Center</a>.</p>"
},
"OriginKeepaliveTimeout":{
"shape":"integer",
"documentation":"<p>You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.</p> <p>If you need to increase the maximum time limit, contact the <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support Center</a>.</p>"
}
},
"documentation":"<p>A customer origin or an Amazon S3 bucket configured as a website endpoint.</p>"
},
"DefaultCacheBehavior":{
"type":"structure",
"required":[
"TargetOriginId",
"ForwardedValues",
"TrustedSigners",
"ViewerProtocolPolicy",
"MinTTL"
],
"members":{
"TargetOriginId":{
"shape":"string",
"documentation":"<p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.</p>"
},
"ForwardedValues":{
"shape":"ForwardedValues",
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
},
"TrustedSigners":{
"shape":"TrustedSigners",
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
},
"ViewerProtocolPolicy":{
"shape":"ViewerProtocolPolicy",
"documentation":"<p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.</p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>"
},
"MinTTL":{
"shape":"long",
"documentation":"<p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>"
},
"AllowedMethods":{"shape":"AllowedMethods"},
"SmoothStreaming":{
"shape":"boolean",
"documentation":"<p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>"
},
"DefaultTTL":{
"shape":"long",
"documentation":"<p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"MaxTTL":{"shape":"long"},
"Compress":{
"shape":"boolean",
"documentation":"<p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"LambdaFunctionAssociations":{
"shape":"LambdaFunctionAssociations",
"documentation":"<p>A complex type that contains zero or more Lambda function associations for a cache behavior.</p>"
},
"FieldLevelEncryptionId":{
"shape":"string",
"documentation":"<p>The value of <code>ID</code> for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.</p>"
}
},
"documentation":"<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
},
"DeleteCloudFrontOriginAccessIdentityRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The origin access identity's ID.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header you received from a previous <code>GET</code> or <code>PUT</code> request. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"documentation":"<p>Deletes a origin access identity.</p>"
},
"DeleteDistributionRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The distribution ID. </p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when you disabled the distribution. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
"location":"header",
"locationName":"If-Match"
}
},
"documentation":"<p>This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete a web distribution using the CloudFront API:</b> </p> <ol> <li> <p>Disable the web distribution </p> </li> <li> <p>Submit a <code>GET Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution.</p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Distribution</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 6.</p> </li> <li> <p>Review the response to your <code>DELETE Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"DeleteFieldLevelEncryptionConfigRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The ID of the configuration you want to delete from CloudFront.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the configuration identity to delete. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
}
},
"DeleteFieldLevelEncryptionProfileRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>Request the ID of the profile you want to delete from CloudFront.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the profile to delete. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
}
},
"DeletePublicKeyRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The ID of the public key you want to remove from CloudFront.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the public key identity to delete. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
}
},
"DeleteStreamingDistributionRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The distribution ID. </p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when you disabled the streaming distribution. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"documentation":"<p>The request to delete a streaming distribution.</p>"
},
"Distribution":{
"type":"structure",
"required":[
"Id",
"ARN",
"Status",
"LastModifiedTime",
"InProgressInvalidationBatches",
"DomainName",
"ActiveTrustedSigners",
"DistributionConfig"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>. </p>"
},
"ARN":{
"shape":"string",
"documentation":"<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
},
"Status":{
"shape":"string",
"documentation":"<p>This response element indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated to all CloudFront edge locations. </p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The date and time the distribution was last modified. </p>"
},
"InProgressInvalidationBatches":{
"shape":"integer",
"documentation":"<p>The number of invalidation batches currently in progress. </p>"
},
"DomainName":{
"shape":"string",
"documentation":"<p>The domain name corresponding to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>. </p>"
},
"ActiveTrustedSigners":{
"shape":"ActiveTrustedSigners",
"documentation":"<p>CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The <code>Signer</code> child element lists the AWS account number of the trusted signer (or an empty <code>Self</code> element if the signer is you). The <code>Signer</code> element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create working signed URLs.</p>"
},
"DistributionConfig":{
"shape":"DistributionConfig",
"documentation":"<p>The current configuration information for the distribution. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/distribution ID/config</code> resource.</p>"
}
},
"documentation":"<p>The distribution's information.</p>"
},
"DistributionAlreadyExists":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The caller reference you attempted to create the distribution with is associated with another distribution.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"DistributionConfig":{
"type":"structure",
"required":[
"CallerReference",
"Origins",
"DefaultCacheBehavior",
"Comment",
"Enabled"
],
"members":{
"CallerReference":{
"shape":"string",
"documentation":"<p>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</p> <p>If the value of <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution, and if the content of the <code>DistributionConfig</code> is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution but the content of the <code>DistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error.</p>"
},
"Aliases":{
"shape":"Aliases",
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>"
},
"DefaultRootObject":{
"shape":"string",
"documentation":"<p>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</p> <p>Specify only the object name, for example, <code>index.html</code>. Don't add a <code>/</code> before the object name.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html\">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"Origins":{
"shape":"Origins",
"documentation":"<p>A complex type that contains information about origins for this distribution. </p>"
},
"DefaultCacheBehavior":{
"shape":"DefaultCacheBehavior",
"documentation":"<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
},
"CacheBehaviors":{
"shape":"CacheBehaviors",
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>"
},
"CustomErrorResponses":{
"shape":"CustomErrorResponses",
"documentation":"<p>A complex type that controls the following:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>Any comments you want to include about the distribution.</p> <p>If you don't want to specify a comment, include an empty <code>Comment</code> element.</p> <p>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</p> <p>To add or change a comment, update the distribution configuration and specify the new comment.</p>"
},
"Logging":{
"shape":"LoggingConfig",
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p> <p>For more information about logging, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html\">Access Logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"PriceClass":{
"shape":"PriceClass",
"documentation":"<p>The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify <code>PriceClass_All</code>, CloudFront responds to requests for your objects from all CloudFront edge locations.</p> <p>If you specify a price class other than <code>PriceClass_All</code>, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.</p> <p>For more information about price classes, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html\">Choosing the Price Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see <a href=\"https://aws.amazon.com/cloudfront/pricing/\">Amazon CloudFront Pricing</a>. For price class information, scroll down to see the table at the bottom of the page.</p>"
},
"Enabled":{
"shape":"boolean",
"documentation":"<p>From this field, you can enable or disable the selected distribution.</p>"
},
"ViewerCertificate":{"shape":"ViewerCertificate"},
"Restrictions":{"shape":"Restrictions"},
"WebACLId":{
"shape":"string",
"documentation":"<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p> <p>AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and 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, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">AWS WAF Developer Guide</a>. </p>"
},
"HttpVersion":{
"shape":"HttpVersion",
"documentation":"<p>(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.</p> <p>For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).</p> <p>In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\" </p>"
},
"IsIPV6Enabled":{
"shape":"boolean",
"documentation":"<p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. </p> <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <code>IpAddress</code> parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html\">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html\">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</p>"
}
},
"documentation":"<p>A distribution configuration.</p>"
},
"DistributionConfigWithTags":{
"type":"structure",
"required":[
"DistributionConfig",
"Tags"
],
"members":{
"DistributionConfig":{
"shape":"DistributionConfig",
"documentation":"<p>A distribution configuration.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A complex type that contains zero or more <code>Tag</code> elements.</p>"
}
},
"documentation":"<p>A distribution Configuration and a list of tags to be associated with the distribution.</p>"
},
"DistributionList":{
"type":"structure",
"required":[
"Marker",
"MaxItems",
"IsTruncated",
"Quantity"
],
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>The value you provided for the <code>Marker</code> request parameter.</p>"
},
"NextMarker":{
"shape":"string",
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your distributions where they left off. </p>"
},
"MaxItems":{
"shape":"integer",
"documentation":"<p>The value you provided for the <code>MaxItems</code> request parameter.</p>"
},
"IsTruncated":{
"shape":"boolean",
"documentation":"<p>A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list.</p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of distributions that were created by the current AWS account. </p>"
},
"Items":{
"shape":"DistributionSummaryList",
"documentation":"<p>A complex type that contains one <code>DistributionSummary</code> element for each distribution that was created by the current AWS account.</p>"
}
},
"documentation":"<p>A distribution list.</p>"
},
"DistributionNotDisabled":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"DistributionSummary":{
"type":"structure",
"required":[
"Id",
"ARN",
"Status",
"LastModifiedTime",
"DomainName",
"Aliases",
"Origins",
"DefaultCacheBehavior",
"CacheBehaviors",
"CustomErrorResponses",
"Comment",
"PriceClass",
"Enabled",
"ViewerCertificate",
"Restrictions",
"WebACLId",
"HttpVersion",
"IsIPV6Enabled"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>"
},
"ARN":{
"shape":"string",
"documentation":"<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
},
"Status":{
"shape":"string",
"documentation":"<p>The current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The date and time the distribution was last modified.</p>"
},
"DomainName":{
"shape":"string",
"documentation":"<p>The domain name that corresponds to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>.</p>"
},
"Aliases":{
"shape":"Aliases",
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>"
},
"Origins":{
"shape":"Origins",
"documentation":"<p>A complex type that contains information about origins for this distribution.</p>"
},
"DefaultCacheBehavior":{
"shape":"DefaultCacheBehavior",
"documentation":"<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
},
"CacheBehaviors":{
"shape":"CacheBehaviors",
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements.</p>"
},
"CustomErrorResponses":{
"shape":"CustomErrorResponses",
"documentation":"<p>A complex type that contains zero or more <code>CustomErrorResponses</code> elements.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>The comment originally specified when this distribution was created.</p>"
},
"PriceClass":{"shape":"PriceClass"},
"Enabled":{
"shape":"boolean",
"documentation":"<p>Whether the distribution is enabled to accept user requests for content.</p>"
},
"ViewerCertificate":{"shape":"ViewerCertificate"},
"Restrictions":{"shape":"Restrictions"},
"WebACLId":{
"shape":"string",
"documentation":"<p>The Web ACL Id (if any) associated with the distribution.</p>"
},
"HttpVersion":{
"shape":"HttpVersion",
"documentation":"<p> Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <code>http2</code>. Viewers that don't support <code>HTTP/2</code> will automatically use an earlier version.</p>"
},
"IsIPV6Enabled":{
"shape":"boolean",
"documentation":"<p>Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.</p>"
}
},
"documentation":"<p>A summary of the information about a CloudFront distribution.</p>"
},
"DistributionSummaryList":{
"type":"list",
"member":{
"shape":"DistributionSummary",
"locationName":"DistributionSummary"
}
},
"EncryptionEntities":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>Number of field pattern items in a field-level encryption content type-profile mapping. </p>"
},
"Items":{
"shape":"EncryptionEntityList",
"documentation":"<p>An array of field patterns in a field-level encryption content type-profile mapping. </p>"
}
},
"documentation":"<p>Complex data type for field-level encryption profiles that includes all of the encryption entities. </p>"
},
"EncryptionEntity":{
"type":"structure",
"required":[
"PublicKeyId",
"ProviderId",
"FieldPatterns"
],
"members":{
"PublicKeyId":{
"shape":"string",
"documentation":"<p>The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns. </p>"
},
"ProviderId":{
"shape":"string",
"documentation":"<p>The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.</p>"
},
"FieldPatterns":{
"shape":"FieldPatterns",
"documentation":"<p>Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive. </p>"
}
},
"documentation":"<p>Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications. </p>"
},
"EncryptionEntityList":{
"type":"list",
"member":{
"shape":"EncryptionEntity",
"locationName":"EncryptionEntity"
}
},
"EventType":{
"type":"string",
"enum":[
"viewer-request",
"viewer-response",
"origin-request",
"origin-response"
]
},
"FieldLevelEncryption":{
"type":"structure",
"required":[
"Id",
"LastModifiedTime",
"FieldLevelEncryptionConfig"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.</p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The last time the field-level encryption configuration was changed. </p>"
},
"FieldLevelEncryptionConfig":{
"shape":"FieldLevelEncryptionConfig",
"documentation":"<p>A complex data type that includes the profile configurations specified for field-level encryption. </p>"
}
},
"documentation":"<p>A complex data type that includes the profile configurations and other options specified for field-level encryption. </p>"
},
"FieldLevelEncryptionConfig":{
"type":"structure",
"required":["CallerReference"],
"members":{
"CallerReference":{
"shape":"string",
"documentation":"<p>A unique number that ensures the request can't be replayed.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>An optional comment about the configuration.</p>"
},
"QueryArgProfileConfig":{
"shape":"QueryArgProfileConfig",
"documentation":"<p>A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.</p>"
},
"ContentTypeProfileConfig":{
"shape":"ContentTypeProfileConfig",
"documentation":"<p>A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.</p>"
}
},
"documentation":"<p>A complex data type that includes the profile configurations specified for field-level encryption. </p>"
},
"FieldLevelEncryptionConfigAlreadyExists":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified configuration for field-level encryption already exists.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"FieldLevelEncryptionConfigInUse":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified configuration for field-level encryption is in use.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"FieldLevelEncryptionList":{
"type":"structure",
"required":[
"MaxItems",
"Quantity"
],
"members":{
"NextMarker":{
"shape":"string",
"documentation":"<p>If there are more elements to be listed, this element is present and contains the value that you can use for the <code>Marker</code> request parameter to continue listing your configurations where you left off.</p>"
},
"MaxItems":{
"shape":"integer",
"documentation":"<p>The maximum number of elements you want in the response body. </p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of field-level encryption items.</p>"
},
"Items":{
"shape":"FieldLevelEncryptionSummaryList",
"documentation":"<p>An array of field-level encryption items.</p>"
}
},
"documentation":"<p>List of field-level encrpytion configurations.</p>"
},
"FieldLevelEncryptionProfile":{
"type":"structure",
"required":[
"Id",
"LastModifiedTime",
"FieldLevelEncryptionProfileConfig"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.</p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The last time the field-level encryption profile was updated.</p>"
},
"FieldLevelEncryptionProfileConfig":{
"shape":"FieldLevelEncryptionProfileConfig",
"documentation":"<p>A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.</p>"
}
},
"documentation":"<p>A complex data type for field-level encryption profiles.</p>"
},
"FieldLevelEncryptionProfileAlreadyExists":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified profile for field-level encryption already exists.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"FieldLevelEncryptionProfileConfig":{
"type":"structure",
"required":[
"Name",
"CallerReference",
"EncryptionEntities"
],
"members":{
"Name":{
"shape":"string",
"documentation":"<p>Profile name for the field-level encryption profile.</p>"
},
"CallerReference":{
"shape":"string",
"documentation":"<p>A unique number that ensures the request can't be replayed.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>An optional comment for the field-level encryption profile.</p>"
},
"EncryptionEntities":{
"shape":"EncryptionEntities",
"documentation":"<p>A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.</p>"
}
},
"documentation":"<p>A complex data type of profiles for the field-level encryption.</p>"
},
"FieldLevelEncryptionProfileInUse":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified profile for field-level encryption is in use.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"FieldLevelEncryptionProfileList":{
"type":"structure",
"required":[
"MaxItems",
"Quantity"
],
"members":{
"NextMarker":{
"shape":"string",
"documentation":"<p>If there are more elements to be listed, this element is present and contains the value that you can use for the <code>Marker</code> request parameter to continue listing your profiles where you left off.</p>"
},
"MaxItems":{
"shape":"integer",
"documentation":"<p>The maximum number of field-level encryption profiles you want in the response body. </p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of field-level encryption profiles.</p>"
},
"Items":{
"shape":"FieldLevelEncryptionProfileSummaryList",
"documentation":"<p>The field-level encryption profile items.</p>"
}
},
"documentation":"<p>List of field-level encryption profiles.</p>"
},
"FieldLevelEncryptionProfileSizeExceeded":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum size of a profile for field-level encryption was exceeded.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"FieldLevelEncryptionProfileSummary":{
"type":"structure",
"required":[
"Id",
"LastModifiedTime",
"Name",
"EncryptionEntities"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>ID for the field-level encryption profile summary.</p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The time when the the field-level encryption profile summary was last updated.</p>"
},
"Name":{
"shape":"string",
"documentation":"<p>Name for the field-level encryption profile summary.</p>"
},
"EncryptionEntities":{
"shape":"EncryptionEntities",
"documentation":"<p>A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>An optional comment for the field-level encryption profile summary.</p>"
}
},
"documentation":"<p>The field-level encryption profile summary.</p>"
},
"FieldLevelEncryptionProfileSummaryList":{
"type":"list",
"member":{
"shape":"FieldLevelEncryptionProfileSummary",
"locationName":"FieldLevelEncryptionProfileSummary"
}
},
"FieldLevelEncryptionSummary":{
"type":"structure",
"required":[
"Id",
"LastModifiedTime"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The unique ID of a field-level encryption item.</p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The last time that the summary of field-level encryption items was modified.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>An optional comment about the field-level encryption item.</p>"
},
"QueryArgProfileConfig":{
"shape":"QueryArgProfileConfig",
"documentation":"<p> A summary of a query argument-profile mapping. </p>"
},
"ContentTypeProfileConfig":{
"shape":"ContentTypeProfileConfig",
"documentation":"<p> A summary of a content type-profile mapping. </p>"
}
},
"documentation":"<p>A summary of a field-level encryption item.</p>"
},
"FieldLevelEncryptionSummaryList":{
"type":"list",
"member":{
"shape":"FieldLevelEncryptionSummary",
"locationName":"FieldLevelEncryptionSummary"
}
},
"FieldPatternList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"FieldPattern"
}
},
"FieldPatterns":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of field-level encryption field patterns.</p>"
},
"Items":{
"shape":"FieldPatternList",
"documentation":"<p>An array of the field-level encryption field patterns.</p>"
}
},
"documentation":"<p>A complex data type that includes the field patterns to match for field-level encryption.</p>"
},
"Format":{
"type":"string",
"enum":["URLEncoded"]
},
"ForwardedValues":{
"type":"structure",
"required":[
"QueryString",
"Cookies"
],
"members":{
"QueryString":{
"shape":"boolean",
"documentation":"<p>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</p> <p>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</p> <p>If you specify true for <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</p> <p>If you specify false for <code>QueryString</code>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html\">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"Cookies":{
"shape":"CookiePreference",
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"Headers":{
"shape":"Headers",
"documentation":"<p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to base caching on for this cache behavior. </p>"
},
"QueryStringCacheKeys":{
"shape":"QueryStringCacheKeys",
"documentation":"<p>A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.</p>"
}
},
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
},
"GeoRestriction":{
"type":"structure",
"required":[
"RestrictionType",
"Quantity"
],
"members":{
"RestrictionType":{
"shape":"GeoRestrictionType",
"documentation":"<p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</p>"
},
"Items":{
"shape":"LocationList",
"documentation":"<p> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.</p>"
}
},
"documentation":"<p>A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using <code>MaxMind</code> GeoIP databases. </p>"
},
"GeoRestrictionType":{
"type":"string",
"enum":[
"blacklist",
"whitelist",
"none"
]
},
"GetCloudFrontOriginAccessIdentityConfigRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The identity's ID. </p>",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"<p>The origin access identity's configuration information. For more information, see <a>CloudFrontOriginAccessIdentityConfigComplexType</a>.</p>"
},
"GetCloudFrontOriginAccessIdentityConfigResult":{
"type":"structure",
"members":{
"CloudFrontOriginAccessIdentityConfig":{
"shape":"CloudFrontOriginAccessIdentityConfig",
"documentation":"<p>The origin access identity's configuration information. </p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"CloudFrontOriginAccessIdentityConfig"
},
"GetCloudFrontOriginAccessIdentityRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The identity's ID.</p>",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"<p>The request to get an origin access identity's information.</p>"
},
"GetCloudFrontOriginAccessIdentityResult":{
"type":"structure",
"members":{
"CloudFrontOriginAccessIdentity":{
"shape":"CloudFrontOriginAccessIdentity",
"documentation":"<p>The origin access identity's information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the origin access identity's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"CloudFrontOriginAccessIdentity"
},
"GetDistributionConfigRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The distribution's ID.</p>",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"<p>The request to get a distribution configuration.</p>"
},
"GetDistributionConfigResult":{
"type":"structure",
"members":{
"DistributionConfig":{
"shape":"DistributionConfig",
"documentation":"<p>The distribution's configuration information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"DistributionConfig"
},
"GetDistributionRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The distribution's ID.</p>",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"<p>The request to get a distribution's information.</p>"
},
"GetDistributionResult":{
"type":"structure",
"members":{
"Distribution":{
"shape":"Distribution",
"documentation":"<p>The distribution's information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the distribution's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"Distribution"
},
"GetFieldLevelEncryptionConfigRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>Request the ID for the field-level encryption configuration information.</p>",
"location":"uri",
"locationName":"Id"
}
}
},
"GetFieldLevelEncryptionConfigResult":{
"type":"structure",
"members":{
"FieldLevelEncryptionConfig":{
"shape":"FieldLevelEncryptionConfig",
"documentation":"<p>Return the field-level encryption configuration information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the field level encryption configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryptionConfig"
},
"GetFieldLevelEncryptionProfileConfigRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>Get the ID for the field-level encryption profile configuration information.</p>",
"location":"uri",
"locationName":"Id"
}
}
},
"GetFieldLevelEncryptionProfileConfigResult":{
"type":"structure",
"members":{
"FieldLevelEncryptionProfileConfig":{
"shape":"FieldLevelEncryptionProfileConfig",
"documentation":"<p>Return the field-level encryption profile configuration information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the field-level encryption profile configuration result. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryptionProfileConfig"
},
"GetFieldLevelEncryptionProfileRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>Get the ID for the field-level encryption profile information.</p>",
"location":"uri",
"locationName":"Id"
}
}
},
"GetFieldLevelEncryptionProfileResult":{
"type":"structure",
"members":{
"FieldLevelEncryptionProfile":{
"shape":"FieldLevelEncryptionProfile",
"documentation":"<p>Return the field-level encryption profile information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the field level encryption profile. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryptionProfile"
},
"GetFieldLevelEncryptionRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>Request the ID for the field-level encryption configuration information.</p>",
"location":"uri",
"locationName":"Id"
}
}
},
"GetFieldLevelEncryptionResult":{
"type":"structure",
"members":{
"FieldLevelEncryption":{
"shape":"FieldLevelEncryption",
"documentation":"<p>Return the field-level encryption configuration information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the field level encryption configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryption"
},
"GetInvalidationRequest":{
"type":"structure",
"required":[
"DistributionId",
"Id"
],
"members":{
"DistributionId":{
"shape":"string",
"documentation":"<p>The distribution's ID.</p>",
"location":"uri",
"locationName":"DistributionId"
},
"Id":{
"shape":"string",
"documentation":"<p>The identifier for the invalidation request, for example, <code>IDFDVBD632BHDS5</code>.</p>",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"<p>The request to get an invalidation's information. </p>"
},
"GetInvalidationResult":{
"type":"structure",
"members":{
"Invalidation":{
"shape":"Invalidation",
"documentation":"<p>The invalidation's information. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/InvalidationDatatype.html\">Invalidation Complex Type</a>. </p>"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"Invalidation"
},
"GetPublicKeyConfigRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>Request the ID for the public key configuration.</p>",
"location":"uri",
"locationName":"Id"
}
}
},
"GetPublicKeyConfigResult":{
"type":"structure",
"members":{
"PublicKeyConfig":{
"shape":"PublicKeyConfig",
"documentation":"<p>Return the result for the public key configuration.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the public key configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"PublicKeyConfig"
},
"GetPublicKeyRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>Request the ID for the public key.</p>",
"location":"uri",
"locationName":"Id"
}
}
},
"GetPublicKeyResult":{
"type":"structure",
"members":{
"PublicKey":{
"shape":"PublicKey",
"documentation":"<p>Return the public key.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the public key. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"PublicKey"
},
"GetStreamingDistributionConfigRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The streaming distribution's ID.</p>",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"<p>To request to get a streaming distribution configuration.</p>"
},
"GetStreamingDistributionConfigResult":{
"type":"structure",
"members":{
"StreamingDistributionConfig":{
"shape":"StreamingDistributionConfig",
"documentation":"<p>The streaming distribution's configuration information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"StreamingDistributionConfig"
},
"GetStreamingDistributionRequest":{
"type":"structure",
"required":["Id"],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The streaming distribution's ID.</p>",
"location":"uri",
"locationName":"Id"
}
},
"documentation":"<p>The request to get a streaming distribution's information.</p>"
},
"GetStreamingDistributionResult":{
"type":"structure",
"members":{
"StreamingDistribution":{
"shape":"StreamingDistribution",
"documentation":"<p>The streaming distribution's information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the streaming distribution's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"StreamingDistribution"
},
"HeaderList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"Name"
}
},
"Headers":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</p> <ul> <li> <p> <b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</p> <important> <p>CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin. </p> </important> </li> <li> <p> <b>Forward a whitelist of headers you specify</b>: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in the specified headers.</p> </li> <li> <p> <b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</p> </li> </ul> <p>Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:</p> <ul> <li> <p> <b>S3 bucket</b>: See <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorS3Origin.html#request-s3-removed-headers\">HTTP Request Headers That CloudFront Removes or Updates</a> </p> </li> <li> <p> <b>Custom origin</b>: See <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorCustomOrigin.html#request-custom-headers-behavior\">HTTP Request Headers and CloudFront Behavior</a> </p> </li> </ul>"
},
"Items":{
"shape":"HeaderList",
"documentation":"<p>A list that contains one <code>Name</code> element for each header that you want CloudFront to use for caching in this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</p>"
}
},
"documentation":"<p>A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior. </p> <p>For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for <code>logo.jpg</code> contain a custom <code>product</code> header that has a value of either <code>acme</code> or <code>apex</code>, and you configure CloudFront to cache your content based on values in the <code>product</code> header. CloudFront forwards the <code>product</code> header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\">How CloudFront Forwards and Caches Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"HttpVersion":{
"type":"string",
"enum":[
"http1.1",
"http2"
]
},
"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified configuration for field-level encryption can't be associated with the specified cache behavior.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"IllegalUpdate":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Origin and <code>CallerReference</code> cannot be updated. </p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InconsistentQuantities":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The value of <code>Quantity</code> and the size of <code>Items</code> don't match.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidArgument":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The argument is invalid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidDefaultRootObject":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The default root object file name is too big or contains an invalid character.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidErrorCode":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidForwardCookies":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Your request contains forward cookies option which doesn't match with the expectation for the <code>whitelisted</code> list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidGeoRestrictionParameter":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidHeadersForS3Origin":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidIfMatchVersion":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The <code>If-Match</code> version is missing or not valid for the distribution.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidLambdaFunctionAssociation":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified Lambda function association is invalid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidLocationCode":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidMinimumProtocolVersion":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidOrigin":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidOriginAccessIdentity":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The origin access identity is not valid or doesn't exist.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidOriginKeepaliveTimeout":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidOriginReadTimeout":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidProtocolSettings":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidQueryStringParameters":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidRelativePath":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The relative path is too big, is not URL-encoded, or does not begin with a slash (/).</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidRequiredProtocol":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the <code>RequiredProtocols</code> element from your distribution configuration.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidResponseCode":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidTTLOrder":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidTagging":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidViewerCertificate":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidWebACLId":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"Invalidation":{
"type":"structure",
"required":[
"Id",
"Status",
"CreateTime",
"InvalidationBatch"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The identifier for the invalidation request. For example: <code>IDFDVBD632BHDS5</code>.</p>"
},
"Status":{
"shape":"string",
"documentation":"<p>The status of the invalidation request. When the invalidation batch is finished, the status is <code>Completed</code>.</p>"
},
"CreateTime":{
"shape":"timestamp",
"documentation":"<p>The date and time the invalidation request was first made. </p>"
},
"InvalidationBatch":{
"shape":"InvalidationBatch",
"documentation":"<p>The current invalidation information for the batch request. </p>"
}
},
"documentation":"<p>An invalidation. </p>"
},
"InvalidationBatch":{
"type":"structure",
"required":[
"Paths",
"CallerReference"
],
"members":{
"Paths":{
"shape":"Paths",
"documentation":"<p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects\">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
},
"CallerReference":{
"shape":"string",
"documentation":"<p>A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for <code>CallerReference</code> and change other values in the request as applicable. One way to ensure that the value of <code>CallerReference</code> is unique is to use a <code>timestamp</code>, for example, <code>20120301090000</code>.</p> <p>If you make a second invalidation request with the same value for <code>CallerReference</code>, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same <code>CallerReference</code>.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous invalidation batch request but the content of any <code>Path</code> is different from the original request, CloudFront returns an <code>InvalidationBatchAlreadyExists</code> error.</p>"
}
},
"documentation":"<p>An invalidation batch.</p>"
},
"InvalidationList":{
"type":"structure",
"required":[
"Marker",
"MaxItems",
"IsTruncated",
"Quantity"
],
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>The value that you provided for the <code>Marker</code> request parameter.</p>"
},
"NextMarker":{
"shape":"string",
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value that you can use for the <code>Marker</code> request parameter to continue listing your invalidation batches where they left off.</p>"
},
"MaxItems":{
"shape":"integer",
"documentation":"<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>"
},
"IsTruncated":{
"shape":"boolean",
"documentation":"<p>A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more invalidation batches in the list.</p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of invalidation batches that were created by the current AWS account. </p>"
},
"Items":{
"shape":"InvalidationSummaryList",
"documentation":"<p>A complex type that contains one <code>InvalidationSummary</code> element for each invalidation batch created by the current AWS account.</p>"
}
},
"documentation":"<p>The <code>InvalidationList</code> complex type describes the list of invalidation objects. For more information about invalidation, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html\">Invalidating Objects (Web Distributions Only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"InvalidationSummary":{
"type":"structure",
"required":[
"Id",
"CreateTime",
"Status"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The unique ID for an invalidation request.</p>"
},
"CreateTime":{"shape":"timestamp"},
"Status":{
"shape":"string",
"documentation":"<p>The status of an invalidation request.</p>"
}
},
"documentation":"<p>A summary of an invalidation request.</p>"
},
"InvalidationSummaryList":{
"type":"list",
"member":{
"shape":"InvalidationSummary",
"locationName":"InvalidationSummary"
}
},
"ItemSelection":{
"type":"string",
"enum":[
"none",
"whitelist",
"all"
]
},
"KeyPairIdList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"KeyPairId"
}
},
"KeyPairIds":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of active CloudFront key pairs for <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
},
"Items":{
"shape":"KeyPairIdList",
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
}
},
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>. </p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
},
"LambdaFunctionARN":{"type":"string"},
"LambdaFunctionAssociation":{
"type":"structure",
"required":[
"LambdaFunctionARN",
"EventType"
],
"members":{
"LambdaFunctionARN":{
"shape":"LambdaFunctionARN",
"documentation":"<p>The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.</p>"
},
"EventType":{
"shape":"EventType",
"documentation":"<p>Specifies the event type that triggers a Lambda function invocation. You can specify the following values:</p> <ul> <li> <p> <code>viewer-request</code>: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. </p> </li> <li> <p> <code>origin-request</code>: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.</p> </li> <li> <p> <code>origin-response</code>: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> <li> <p> <code>viewer-response</code>: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> </ul>"
},
"IncludeBody":{
"shape":"boolean",
"documentation":"<p>A flag that allows a Lambda function to have read access to the body content. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/\">Accessing Body Content</a> in the Amazon CloudFront Developer Guide.</p>"
}
},
"documentation":"<p>A complex type that contains a Lambda function association.</p>"
},
"LambdaFunctionAssociationList":{
"type":"list",
"member":{
"shape":"LambdaFunctionAssociation",
"locationName":"LambdaFunctionAssociation"
}
},
"LambdaFunctionAssociations":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of Lambda function associations for this cache behavior.</p>"
},
"Items":{
"shape":"LambdaFunctionAssociationList",
"documentation":"<p> <b>Optional</b>: A complex type that contains <code>LambdaFunctionAssociation</code> items for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
}
},
"documentation":"<p>A complex type that specifies a list of Lambda functions associations for a cache behavior.</p> <p>If you want to invoke one or more Lambda functions triggered by requests that match the <code>PathPattern</code> of the cache behavior, specify the applicable values for <code>Quantity</code> and <code>Items</code>. Note that there can be up to 4 <code>LambdaFunctionAssociation</code> items in this list (one for each possible value of <code>EventType</code>) and each <code>EventType</code> can be associated with the Lambda function only once.</p> <p>If you don't want to invoke any Lambda functions for the requests that match <code>PathPattern</code>, specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. </p>"
},
"ListCloudFrontOriginAccessIdentitiesRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page).</p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The maximum number of origin access identities you want in the response body. </p>",
"location":"querystring",
"locationName":"MaxItems"
}
},
"documentation":"<p>The request to list origin access identities. </p>"
},
"ListCloudFrontOriginAccessIdentitiesResult":{
"type":"structure",
"members":{
"CloudFrontOriginAccessIdentityList":{
"shape":"CloudFrontOriginAccessIdentityList",
"documentation":"<p>The <code>CloudFrontOriginAccessIdentityList</code> type. </p>"
}
},
"documentation":"<p>The returned result of the corresponding request. </p>",
"payload":"CloudFrontOriginAccessIdentityList"
},
"ListDistributionsByWebACLIdRequest":{
"type":"structure",
"required":["WebACLId"],
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>Use <code>Marker</code> and <code>MaxItems</code> to control pagination of results. If you have more than <code>MaxItems</code> distributions that satisfy the request, the response includes a <code>NextMarker</code> element. To get the next page of results, submit another request. For the value of <code>Marker</code>, specify the value of <code>NextMarker</code> from the last response. (For the first request, omit <code>Marker</code>.) </p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.</p>",
"location":"querystring",
"locationName":"MaxItems"
},
"WebACLId":{
"shape":"string",
"documentation":"<p>The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL. </p>",
"location":"uri",
"locationName":"WebACLId"
}
},
"documentation":"<p>The request to list distributions that are associated with a specified AWS WAF web ACL. </p>"
},
"ListDistributionsByWebACLIdResult":{
"type":"structure",
"members":{
"DistributionList":{
"shape":"DistributionList",
"documentation":"<p>The <code>DistributionList</code> type. </p>"
}
},
"documentation":"<p>The response to a request to list the distributions that are associated with a specified AWS WAF web ACL. </p>",
"payload":"DistributionList"
},
"ListDistributionsRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last distribution on that page).</p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The maximum number of distributions you want in the response body.</p>",
"location":"querystring",
"locationName":"MaxItems"
}
},
"documentation":"<p>The request to list your distributions. </p>"
},
"ListDistributionsResult":{
"type":"structure",
"members":{
"DistributionList":{
"shape":"DistributionList",
"documentation":"<p>The <code>DistributionList</code> type. </p>"
}
},
"documentation":"<p>The returned result of the corresponding request. </p>",
"payload":"DistributionList"
},
"ListFieldLevelEncryptionConfigsRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last configuration on that page). </p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The maximum number of field-level encryption configurations you want in the response body. </p>",
"location":"querystring",
"locationName":"MaxItems"
}
}
},
"ListFieldLevelEncryptionConfigsResult":{
"type":"structure",
"members":{
"FieldLevelEncryptionList":{
"shape":"FieldLevelEncryptionList",
"documentation":"<p>Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.</p>"
}
},
"payload":"FieldLevelEncryptionList"
},
"ListFieldLevelEncryptionProfilesRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last profile on that page). </p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The maximum number of field-level encryption profiles you want in the response body. </p>",
"location":"querystring",
"locationName":"MaxItems"
}
}
},
"ListFieldLevelEncryptionProfilesResult":{
"type":"structure",
"members":{
"FieldLevelEncryptionProfileList":{
"shape":"FieldLevelEncryptionProfileList",
"documentation":"<p>Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.</p>"
}
},
"payload":"FieldLevelEncryptionProfileList"
},
"ListInvalidationsRequest":{
"type":"structure",
"required":["DistributionId"],
"members":{
"DistributionId":{
"shape":"string",
"documentation":"<p>The distribution's ID.</p>",
"location":"uri",
"locationName":"DistributionId"
},
"Marker":{
"shape":"string",
"documentation":"<p>Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response. This value is the same as the ID of the last invalidation batch on that page. </p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The maximum number of invalidation batches that you want in the response body.</p>",
"location":"querystring",
"locationName":"MaxItems"
}
},
"documentation":"<p>The request to list invalidations. </p>"
},
"ListInvalidationsResult":{
"type":"structure",
"members":{
"InvalidationList":{
"shape":"InvalidationList",
"documentation":"<p>Information about invalidation batches. </p>"
}
},
"documentation":"<p>The returned result of the corresponding request. </p>",
"payload":"InvalidationList"
},
"ListPublicKeysRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last public key on that page). </p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The maximum number of public keys you want in the response body. </p>",
"location":"querystring",
"locationName":"MaxItems"
}
}
},
"ListPublicKeysResult":{
"type":"structure",
"members":{
"PublicKeyList":{
"shape":"PublicKeyList",
"documentation":"<p>Returns a list of all public keys that have been added to CloudFront for this account.</p>"
}
},
"payload":"PublicKeyList"
},
"ListStreamingDistributionsRequest":{
"type":"structure",
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>The value that you provided for the <code>Marker</code> request parameter.</p>",
"location":"querystring",
"locationName":"Marker"
},
"MaxItems":{
"shape":"string",
"documentation":"<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>",
"location":"querystring",
"locationName":"MaxItems"
}
},
"documentation":"<p>The request to list your streaming distributions. </p>"
},
"ListStreamingDistributionsResult":{
"type":"structure",
"members":{
"StreamingDistributionList":{
"shape":"StreamingDistributionList",
"documentation":"<p>The <code>StreamingDistributionList</code> type. </p>"
}
},
"documentation":"<p>The returned result of the corresponding request. </p>",
"payload":"StreamingDistributionList"
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["Resource"],
"members":{
"Resource":{
"shape":"ResourceARN",
"documentation":"<p> An ARN of a CloudFront resource.</p>",
"location":"querystring",
"locationName":"Resource"
}
},
"documentation":"<p> The request to list tags for a CloudFront resource.</p>"
},
"ListTagsForResourceResult":{
"type":"structure",
"required":["Tags"],
"members":{
"Tags":{
"shape":"Tags",
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
}
},
"documentation":"<p> The returned result of the corresponding request.</p>",
"payload":"Tags"
},
"LocationList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"Location"
}
},
"LoggingConfig":{
"type":"structure",
"required":[
"Enabled",
"IncludeCookies",
"Bucket",
"Prefix"
],
"members":{
"Enabled":{
"shape":"boolean",
"documentation":"<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, the values are automatically deleted.</p>"
},
"IncludeCookies":{
"shape":"boolean",
"documentation":"<p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <code>false</code> for <code>IncludeCookies</code>.</p>"
},
"Bucket":{
"shape":"string",
"documentation":"<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>"
},
"Prefix":{
"shape":"string",
"documentation":"<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>"
}
},
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p>"
},
"Method":{
"type":"string",
"enum":[
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"OPTIONS",
"DELETE"
]
},
"MethodsList":{
"type":"list",
"member":{
"shape":"Method",
"locationName":"Method"
}
},
"MinimumProtocolVersion":{
"type":"string",
"enum":[
"SSLv3",
"TLSv1",
"TLSv1_2016",
"TLSv1.1_2016",
"TLSv1.2_2018"
]
},
"MissingBody":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>This operation requires a body. Ensure that the body is present and the <code>Content-Type</code> header is set.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"NoSuchCloudFrontOriginAccessIdentity":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified origin access identity does not exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchDistribution":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified distribution does not exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchFieldLevelEncryptionConfig":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified configuration for field-level encryption doesn't exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchFieldLevelEncryptionProfile":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified profile for field-level encryption doesn't exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchInvalidation":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified invalidation does not exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchOrigin":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>No origin exists with the specified <code>Origin Id</code>. </p>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchPublicKey":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified public key doesn't exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchResource":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":404},
"exception":true
},
"NoSuchStreamingDistribution":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified streaming distribution does not exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"Origin":{
"type":"structure",
"required":[
"Id",
"DomainName"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>A unique identifier for the origin. The value of <code>Id</code> must be unique within the distribution.</p> <p>When you specify the value of <code>TargetOriginId</code> for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the <code>Id</code> element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"DomainName":{
"shape":"string",
"documentation":"<p> <b>Amazon S3 origins</b>: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, <code>myawsbucket.s3.amazonaws.com</code>. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.</p> <p>Constraints for Amazon S3 origins: </p> <ul> <li> <p>If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the <code>s3-accelerate</code> endpoint for <code>DomainName</code>.</p> </li> <li> <p>The bucket name must be between 3 and 63 characters long (inclusive).</p> </li> <li> <p>The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.</p> </li> <li> <p>The bucket name must not contain adjacent periods.</p> </li> </ul> <p> <b>Custom Origins</b>: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, <code>www.example.com</code>. </p> <p>Constraints for custom origins:</p> <ul> <li> <p> <code>DomainName</code> must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.</p> </li> <li> <p>The name cannot exceed 128 characters.</p> </li> </ul>"
},
"OriginPath":{
"shape":"string",
"documentation":"<p>An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the <code>OriginPath</code> element, specify the directory name, beginning with a <code>/</code>. CloudFront appends the directory name to the value of <code>DomainName</code>, for example, <code>example.com/production</code>. Do not include a <code>/</code> at the end of the directory name.</p> <p>For example, suppose you've specified the following values for your distribution:</p> <ul> <li> <p> <code>DomainName</code>: An Amazon S3 bucket named <code>myawsbucket</code>.</p> </li> <li> <p> <code>OriginPath</code>: <code>/production</code> </p> </li> <li> <p> <code>CNAME</code>: <code>example.com</code> </p> </li> </ul> <p>When a user enters <code>example.com/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/index.html</code>.</p> <p>When a user enters <code>example.com/acme/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/acme/index.html</code>.</p>"
},
"CustomHeaders":{
"shape":"CustomHeaders",
"documentation":"<p>A complex type that contains names and values for the custom headers that you want.</p>"
},
"S3OriginConfig":{
"shape":"S3OriginConfig",
"documentation":"<p>A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the <code>CustomOriginConfig</code> element instead.</p>"
},
"CustomOriginConfig":{
"shape":"CustomOriginConfig",
"documentation":"<p>A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the <code>S3OriginConfig</code> element instead.</p>"
}
},
"documentation":"<p>A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.</p> <p>For the current limit on the number of origins that you can create for a distribution, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
},
"OriginCustomHeader":{
"type":"structure",
"required":[
"HeaderName",
"HeaderValue"
],
"members":{
"HeaderName":{
"shape":"string",
"documentation":"<p>The name of a header that you want CloudFront to forward to your origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html\">Forwarding Custom Headers to Your Origin (Web Distributions Only)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
},
"HeaderValue":{
"shape":"string",
"documentation":"<p>The value for the header that you specified in the <code>HeaderName</code> field.</p>"
}
},
"documentation":"<p>A complex type that contains <code>HeaderName</code> and <code>HeaderValue</code> elements, if any, for this distribution. </p>"
},
"OriginCustomHeadersList":{
"type":"list",
"member":{
"shape":"OriginCustomHeader",
"locationName":"OriginCustomHeader"
}
},
"OriginList":{
"type":"list",
"member":{
"shape":"Origin",
"locationName":"Origin"
},
"min":1
},
"OriginProtocolPolicy":{
"type":"string",
"enum":[
"http-only",
"match-viewer",
"https-only"
]
},
"OriginSslProtocols":{
"type":"structure",
"required":[
"Quantity",
"Items"
],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. </p>"
},
"Items":{
"shape":"SslProtocolsList",
"documentation":"<p>A list that contains allowed SSL/TLS protocols for this distribution.</p>"
}
},
"documentation":"<p>A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. </p>"
},
"Origins":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of origins for this distribution.</p>"
},
"Items":{
"shape":"OriginList",
"documentation":"<p>A complex type that contains origins for this distribution.</p>"
}
},
"documentation":"<p>A complex type that contains information about origins for this distribution. </p>"
},
"PathList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"Path"
}
},
"Paths":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of objects that you want to invalidate.</p>"
},
"Items":{
"shape":"PathList",
"documentation":"<p>A complex type that contains a list of the paths that you want to invalidate.</p>"
}
},
"documentation":"<p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects\">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
},
"PreconditionFailed":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The precondition given in one or more of the request-header fields evaluated to <code>false</code>. </p>",
"error":{"httpStatusCode":412},
"exception":true
},
"PriceClass":{
"type":"string",
"enum":[
"PriceClass_100",
"PriceClass_200",
"PriceClass_All"
]
},
"PublicKey":{
"type":"structure",
"required":[
"Id",
"CreatedTime",
"PublicKeyConfig"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>A unique ID assigned to a public key you've added to CloudFront.</p>"
},
"CreatedTime":{
"shape":"timestamp",
"documentation":"<p>A time you added a public key to CloudFront.</p>"
},
"PublicKeyConfig":{
"shape":"PublicKeyConfig",
"documentation":"<p>A complex data type for a public key you add to CloudFront to use with features like field-level encryption.</p>"
}
},
"documentation":"<p>A complex data type of public keys you add to CloudFront to use with features like field-level encryption.</p>"
},
"PublicKeyAlreadyExists":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified public key already exists.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"PublicKeyConfig":{
"type":"structure",
"required":[
"CallerReference",
"Name",
"EncodedKey"
],
"members":{
"CallerReference":{
"shape":"string",
"documentation":"<p>A unique number that ensures the request can't be replayed.</p>"
},
"Name":{
"shape":"string",
"documentation":"<p>The name for a public key you add to CloudFront to use with features like field-level encryption.</p>"
},
"EncodedKey":{
"shape":"string",
"documentation":"<p>The encoded public key that you want to add to CloudFront to use with features like field-level encryption.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>An optional comment about a public key.</p>"
}
},
"documentation":"<p>Information about a public key you add to CloudFront to use with features like field-level encryption.</p>"
},
"PublicKeyInUse":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The specified public key is in use. </p>",
"error":{"httpStatusCode":409},
"exception":true
},
"PublicKeyList":{
"type":"structure",
"required":[
"MaxItems",
"Quantity"
],
"members":{
"NextMarker":{
"shape":"string",
"documentation":"<p>If there are more elements to be listed, this element is present and contains the value that you can use for the <code>Marker</code> request parameter to continue listing your public keys where you left off.</p>"
},
"MaxItems":{
"shape":"integer",
"documentation":"<p>The maximum number of public keys you want in the response body. </p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of public keys you added to CloudFront to use with features like field-level encryption.</p>"
},
"Items":{
"shape":"PublicKeySummaryList",
"documentation":"<p>An array of information about a public key you add to CloudFront to use with features like field-level encryption.</p>"
}
},
"documentation":"<p>A list of public keys you've added to CloudFront to use with features like field-level encryption.</p>"
},
"PublicKeySummary":{
"type":"structure",
"required":[
"Id",
"Name",
"CreatedTime",
"EncodedKey"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p> ID for public key information summary. </p>"
},
"Name":{
"shape":"string",
"documentation":"<p> Name for public key information summary. </p>"
},
"CreatedTime":{
"shape":"timestamp",
"documentation":"<p> Creation time for public key information summary. </p>"
},
"EncodedKey":{
"shape":"string",
"documentation":"<p> Encoded key for public key information summary. </p>"
},
"Comment":{
"shape":"string",
"documentation":"<p> Comment for public key information summary. </p>"
}
},
"documentation":"<p> Public key information summary. </p>"
},
"PublicKeySummaryList":{
"type":"list",
"member":{
"shape":"PublicKeySummary",
"locationName":"PublicKeySummary"
}
},
"QueryArgProfile":{
"type":"structure",
"required":[
"QueryArg",
"ProfileId"
],
"members":{
"QueryArg":{
"shape":"string",
"documentation":"<p>Query argument for field-level encryption query argument-profile mapping.</p>"
},
"ProfileId":{
"shape":"string",
"documentation":"<p>ID of profile to use for field-level encryption query argument-profile mapping</p>"
}
},
"documentation":"<p>Query argument-profile mapping for field-level encryption.</p>"
},
"QueryArgProfileConfig":{
"type":"structure",
"required":["ForwardWhenQueryArgProfileIsUnknown"],
"members":{
"ForwardWhenQueryArgProfileIsUnknown":{
"shape":"boolean",
"documentation":"<p>Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.</p>"
},
"QueryArgProfiles":{
"shape":"QueryArgProfiles",
"documentation":"<p>Profiles specified for query argument-profile mapping for field-level encryption.</p>"
}
},
"documentation":"<p>Configuration for query argument-profile mapping for field-level encryption.</p>"
},
"QueryArgProfileEmpty":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>No profile specified for the field-level encryption query argument.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"QueryArgProfileList":{
"type":"list",
"member":{
"shape":"QueryArgProfile",
"locationName":"QueryArgProfile"
}
},
"QueryArgProfiles":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>Number of profiles for query argument-profile mapping for field-level encryption.</p>"
},
"Items":{
"shape":"QueryArgProfileList",
"documentation":"<p>Number of items for query argument-profile mapping for field-level encryption.</p>"
}
},
"documentation":"<p>Query argument-profile mapping for field-level encryption.</p>"
},
"QueryStringCacheKeys":{
"type":"structure",
"required":["Quantity"],
"members":{
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of <code>whitelisted</code> query string parameters for this cache behavior.</p>"
},
"Items":{
"shape":"QueryStringCacheKeysList",
"documentation":"<p>(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If <code>Quantity</code> is 0, you can omit <code>Items</code>. </p>"
}
}
},
"QueryStringCacheKeysList":{
"type":"list",
"member":{
"shape":"string",
"locationName":"Name"
}
},
"ResourceARN":{
"type":"string",
"pattern":"arn:aws:cloudfront::[0-9]+:.*"
},
"Restrictions":{
"type":"structure",
"required":["GeoRestriction"],
"members":{
"GeoRestriction":{"shape":"GeoRestriction"}
},
"documentation":"<p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>"
},
"S3Origin":{
"type":"structure",
"required":[
"DomainName",
"OriginAccessIdentity"
],
"members":{
"DomainName":{
"shape":"string",
"documentation":"<p>The DNS name of the Amazon S3 origin. </p>"
},
"OriginAccessIdentity":{
"shape":"string",
"documentation":"<p>The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.</p> <p>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html\">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
}
},
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.</p>"
},
"S3OriginConfig":{
"type":"structure",
"required":["OriginAccessIdentity"],
"members":{
"OriginAccessIdentity":{
"shape":"string",
"documentation":"<p>The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format of the value is:</p> <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p> <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the <code>ID</code> element when you created the origin access identity.</p> <p>If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information about the origin access identity, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"documentation":"<p>A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the <code>CustomOriginConfig</code> element instead.</p>"
},
"SSLSupportMethod":{
"type":"string",
"enum":[
"sni-only",
"vip"
]
},
"Signer":{
"type":"structure",
"members":{
"AwsAccountNumber":{
"shape":"string",
"documentation":"<p>An AWS account that is included in the <code>TrustedSigners</code> complex type for this RTMP distribution. Valid values include:</p> <ul> <li> <p> <code>self</code>, which is the AWS account used to create the distribution.</p> </li> <li> <p>An AWS account number.</p> </li> </ul>"
},
"KeyPairIds":{
"shape":"KeyPairIds",
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>.</p>"
}
},
"documentation":"<p>A complex type that lists the AWS accounts that were included in the <code>TrustedSigners</code> complex type, as well as their active CloudFront key pair IDs, if any. </p>"
},
"SignerList":{
"type":"list",
"member":{
"shape":"Signer",
"locationName":"Signer"
}
},
"SslProtocol":{
"type":"string",
"enum":[
"SSLv3",
"TLSv1",
"TLSv1.1",
"TLSv1.2"
]
},
"SslProtocolsList":{
"type":"list",
"member":{
"shape":"SslProtocol",
"locationName":"SslProtocol"
}
},
"StreamingDistribution":{
"type":"structure",
"required":[
"Id",
"ARN",
"Status",
"DomainName",
"ActiveTrustedSigners",
"StreamingDistributionConfig"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The identifier for the RTMP distribution. For example: <code>EGTXBD79EXAMPLE</code>.</p>"
},
"ARN":{"shape":"string"},
"Status":{
"shape":"string",
"documentation":"<p>The current status of the RTMP distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The date and time that the distribution was last modified. </p>"
},
"DomainName":{
"shape":"string",
"documentation":"<p>The domain name that corresponds to the streaming distribution, for example, <code>s5c39gqb8ow64r.cloudfront.net</code>. </p>"
},
"ActiveTrustedSigners":{
"shape":"ActiveTrustedSigners",
"documentation":"<p>A complex type that lists the AWS accounts, if any, that you included in the <code>TrustedSigners</code> complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.</p> <p>The <code>Signer</code> complex type lists the AWS account number of the trusted signer or <code>self</code> if the signer is the AWS account that created the distribution. The <code>Signer</code> element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create signed URLs.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
},
"StreamingDistributionConfig":{
"shape":"StreamingDistributionConfig",
"documentation":"<p>The current configuration information for the RTMP distribution.</p>"
}
},
"documentation":"<p>A streaming distribution. </p>"
},
"StreamingDistributionAlreadyExists":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"StreamingDistributionConfig":{
"type":"structure",
"required":[
"CallerReference",
"S3Origin",
"Comment",
"TrustedSigners",
"Enabled"
],
"members":{
"CallerReference":{
"shape":"string",
"documentation":"<p>A unique number that ensures that the request can't be replayed. If the <code>CallerReference</code> is new (no matter the content of the <code>StreamingDistributionConfig</code> object), a new streaming distribution is created. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution, and the content of the <code>StreamingDistributionConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution but the content of the <code>StreamingDistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error. </p>"
},
"S3Origin":{
"shape":"S3Origin",
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. </p>"
},
"Aliases":{
"shape":"Aliases",
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. </p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>Any comments you want to include about the streaming distribution. </p>"
},
"Logging":{
"shape":"StreamingLoggingConfig",
"documentation":"<p>A complex type that controls whether access logs are written for the streaming distribution. </p>"
},
"TrustedSigners":{
"shape":"TrustedSigners",
"documentation":"<p>A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
},
"PriceClass":{
"shape":"PriceClass",
"documentation":"<p>A complex type that contains information about price class for this streaming distribution. </p>"
},
"Enabled":{
"shape":"boolean",
"documentation":"<p>Whether the streaming distribution is enabled to accept user requests for content.</p>"
}
},
"documentation":"<p>The RTMP distribution's configuration information.</p>"
},
"StreamingDistributionConfigWithTags":{
"type":"structure",
"required":[
"StreamingDistributionConfig",
"Tags"
],
"members":{
"StreamingDistributionConfig":{
"shape":"StreamingDistributionConfig",
"documentation":"<p>A streaming distribution Configuration.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A complex type that contains zero or more <code>Tag</code> elements.</p>"
}
},
"documentation":"<p>A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.</p>"
},
"StreamingDistributionList":{
"type":"structure",
"required":[
"Marker",
"MaxItems",
"IsTruncated",
"Quantity"
],
"members":{
"Marker":{
"shape":"string",
"documentation":"<p>The value you provided for the <code>Marker</code> request parameter. </p>"
},
"NextMarker":{
"shape":"string",
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your RTMP distributions where they left off. </p>"
},
"MaxItems":{
"shape":"integer",
"documentation":"<p>The value you provided for the <code>MaxItems</code> request parameter. </p>"
},
"IsTruncated":{
"shape":"boolean",
"documentation":"<p>A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list. </p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of streaming distributions that were created by the current AWS account. </p>"
},
"Items":{
"shape":"StreamingDistributionSummaryList",
"documentation":"<p>A complex type that contains one <code>StreamingDistributionSummary</code> element for each distribution that was created by the current AWS account.</p>"
}
},
"documentation":"<p>A streaming distribution list. </p>"
},
"StreamingDistributionNotDisabled":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"StreamingDistributionSummary":{
"type":"structure",
"required":[
"Id",
"ARN",
"Status",
"LastModifiedTime",
"DomainName",
"S3Origin",
"Aliases",
"TrustedSigners",
"Comment",
"PriceClass",
"Enabled"
],
"members":{
"Id":{
"shape":"string",
"documentation":"<p>The identifier for the distribution, for example, <code>EDFDVBD632BHDS5</code>.</p>"
},
"ARN":{
"shape":"string",
"documentation":"<p> The ARN (Amazon Resource Name) for the streaming distribution. For example: <code>arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
},
"Status":{
"shape":"string",
"documentation":"<p> Indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated throughout the Amazon CloudFront system.</p>"
},
"LastModifiedTime":{
"shape":"timestamp",
"documentation":"<p>The date and time the distribution was last modified.</p>"
},
"DomainName":{
"shape":"string",
"documentation":"<p>The domain name corresponding to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>.</p>"
},
"S3Origin":{
"shape":"S3Origin",
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.</p>"
},
"Aliases":{
"shape":"Aliases",
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.</p>"
},
"TrustedSigners":{
"shape":"TrustedSigners",
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>.If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>. To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
},
"Comment":{
"shape":"string",
"documentation":"<p>The comment originally specified when this distribution was created.</p>"
},
"PriceClass":{"shape":"PriceClass"},
"Enabled":{
"shape":"boolean",
"documentation":"<p>Whether the distribution is enabled to accept end user requests for content.</p>"
}
},
"documentation":"<p> A summary of the information for an Amazon CloudFront streaming distribution.</p>"
},
"StreamingDistributionSummaryList":{
"type":"list",
"member":{
"shape":"StreamingDistributionSummary",
"locationName":"StreamingDistributionSummary"
}
},
"StreamingLoggingConfig":{
"type":"structure",
"required":[
"Enabled",
"Bucket",
"Prefix"
],
"members":{
"Enabled":{
"shape":"boolean",
"documentation":"<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </p>"
},
"Bucket":{
"shape":"string",
"documentation":"<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>"
},
"Prefix":{
"shape":"string",
"documentation":"<p>An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>"
}
},
"documentation":"<p>A complex type that controls whether access logs are written for this streaming distribution.</p>"
},
"Tag":{
"type":"structure",
"required":["Key"],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p> A string that contains <code>Tag</code> key.</p> <p>The string length should be between 1 and 128 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p> A string that contains an optional <code>Tag</code> value.</p> <p>The string length should be between 0 and 256 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>"
}
},
"documentation":"<p> A complex type that contains <code>Tag</code> key and <code>Tag</code> value.</p>"
},
"TagKey":{
"type":"string",
"documentation":"<p> A string that contains <code>Tag</code> key.</p> <p>The string length should be between 1 and 128 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagKeyList":{
"type":"list",
"member":{
"shape":"TagKey",
"locationName":"Key"
}
},
"TagKeys":{
"type":"structure",
"members":{
"Items":{
"shape":"TagKeyList",
"documentation":"<p> A complex type that contains <code>Tag</code> key elements.</p>"
}
},
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
},
"TagList":{
"type":"list",
"member":{
"shape":"Tag",
"locationName":"Tag"
}
},
"TagResourceRequest":{
"type":"structure",
"required":[
"Resource",
"Tags"
],
"members":{
"Resource":{
"shape":"ResourceARN",
"documentation":"<p> An ARN of a CloudFront resource.</p>",
"location":"querystring",
"locationName":"Resource"
},
"Tags":{
"shape":"Tags",
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>",
"locationName":"Tags",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p> The request to add tags to a CloudFront resource.</p>",
"payload":"Tags"
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"Tags":{
"type":"structure",
"members":{
"Items":{
"shape":"TagList",
"documentation":"<p> A complex type that contains <code>Tag</code> elements.</p>"
}
},
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
},
"TooManyCacheBehaviors":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>You cannot create more cache behaviors for the distribution.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyCertificates":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>You cannot create anymore custom SSL/TLS certificates.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyCloudFrontOriginAccessIdentities":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Processing your request would cause you to exceed the maximum number of origin access identities allowed.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyCookieNamesInWhiteList":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Your request contains more cookie names in the whitelist than are allowed per cache behavior.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyDistributionCNAMEs":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Your request contains more CNAMEs than are allowed per distribution.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyDistributions":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Processing your request would cause you to exceed the maximum number of distributions allowed.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of distributions have been associated with the specified configuration for field-level encryption.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyDistributionsWithLambdaAssociations":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyFieldLevelEncryptionConfigs":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of configurations for field-level encryption have been created.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyFieldLevelEncryptionContentTypeProfiles":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of content type profiles for field-level encryption have been created.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyFieldLevelEncryptionEncryptionEntities":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of encryption entities for field-level encryption have been created.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyFieldLevelEncryptionFieldPatterns":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of field patterns for field-level encryption have been created.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyFieldLevelEncryptionProfiles":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of profiles for field-level encryption have been created.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyFieldLevelEncryptionQueryArgProfiles":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of query arg profiles for field-level encryption have been created.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyHeadersInForwardedValues":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyInvalidationsInProgress":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyLambdaFunctionAssociations":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Your request contains more Lambda function associations than are allowed per distribution.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyOriginCustomHeaders":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyOrigins":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>You cannot create more origins for the distribution.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyPublicKeys":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyQueryStringParameters":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyStreamingDistributionCNAMEs":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyStreamingDistributions":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Processing your request would cause you to exceed the maximum number of streaming distributions allowed.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TooManyTrustedSigners":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>Your request contains more trusted signers than are allowed per distribution.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TrustedSignerDoesNotExist":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"documentation":"<p>One or more of your trusted signers don't exist.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TrustedSigners":{
"type":"structure",
"required":[
"Enabled",
"Quantity"
],
"members":{
"Enabled":{
"shape":"boolean",
"documentation":"<p>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</p>"
},
"Quantity":{
"shape":"integer",
"documentation":"<p>The number of trusted signers for this cache behavior.</p>"
},
"Items":{
"shape":"AwsAccountNumberList",
"documentation":"<p> <b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
}
},
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p> <p>For more information about updating the distribution configuration, see <a>DistributionConfig</a> .</p>"
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"Resource",
"TagKeys"
],
"members":{
"Resource":{
"shape":"ResourceARN",
"documentation":"<p> An ARN of a CloudFront resource.</p>",
"location":"querystring",
"locationName":"Resource"
},
"TagKeys":{
"shape":"TagKeys",
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> key elements.</p>",
"locationName":"TagKeys",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
}
},
"documentation":"<p> The request to remove tags from a CloudFront resource.</p>",
"payload":"TagKeys"
},
"UpdateCloudFrontOriginAccessIdentityRequest":{
"type":"structure",
"required":[
"CloudFrontOriginAccessIdentityConfig",
"Id"
],
"members":{
"CloudFrontOriginAccessIdentityConfig":{
"shape":"CloudFrontOriginAccessIdentityConfig",
"documentation":"<p>The identity's configuration information.</p>",
"locationName":"CloudFrontOriginAccessIdentityConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
},
"Id":{
"shape":"string",
"documentation":"<p>The identity's id.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the identity's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"documentation":"<p>The request to update an origin access identity.</p>",
"payload":"CloudFrontOriginAccessIdentityConfig"
},
"UpdateCloudFrontOriginAccessIdentityResult":{
"type":"structure",
"members":{
"CloudFrontOriginAccessIdentity":{
"shape":"CloudFrontOriginAccessIdentity",
"documentation":"<p>The origin access identity's information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"CloudFrontOriginAccessIdentity"
},
"UpdateDistributionRequest":{
"type":"structure",
"required":[
"DistributionConfig",
"Id"
],
"members":{
"DistributionConfig":{
"shape":"DistributionConfig",
"documentation":"<p>The distribution's configuration information.</p>",
"locationName":"DistributionConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
},
"Id":{
"shape":"string",
"documentation":"<p>The distribution's id.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"documentation":"<p>The request to update a distribution.</p>",
"payload":"DistributionConfig"
},
"UpdateDistributionResult":{
"type":"structure",
"members":{
"Distribution":{
"shape":"Distribution",
"documentation":"<p>The distribution's information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"Distribution"
},
"UpdateFieldLevelEncryptionConfigRequest":{
"type":"structure",
"required":[
"FieldLevelEncryptionConfig",
"Id"
],
"members":{
"FieldLevelEncryptionConfig":{
"shape":"FieldLevelEncryptionConfig",
"documentation":"<p>Request to update a field-level encryption configuration. </p>",
"locationName":"FieldLevelEncryptionConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
},
"Id":{
"shape":"string",
"documentation":"<p>The ID of the configuration you want to update.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the configuration identity to update. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"payload":"FieldLevelEncryptionConfig"
},
"UpdateFieldLevelEncryptionConfigResult":{
"type":"structure",
"members":{
"FieldLevelEncryption":{
"shape":"FieldLevelEncryption",
"documentation":"<p>Return the results of updating the configuration.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when updating the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryption"
},
"UpdateFieldLevelEncryptionProfileRequest":{
"type":"structure",
"required":[
"FieldLevelEncryptionProfileConfig",
"Id"
],
"members":{
"FieldLevelEncryptionProfileConfig":{
"shape":"FieldLevelEncryptionProfileConfig",
"documentation":"<p>Request to update a field-level encryption profile. </p>",
"locationName":"FieldLevelEncryptionProfileConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
},
"Id":{
"shape":"string",
"documentation":"<p>The ID of the field-level encryption profile request. </p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the profile identity to update. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"payload":"FieldLevelEncryptionProfileConfig"
},
"UpdateFieldLevelEncryptionProfileResult":{
"type":"structure",
"members":{
"FieldLevelEncryptionProfile":{
"shape":"FieldLevelEncryptionProfile",
"documentation":"<p>Return the results of updating the profile.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The result of the field-level encryption profile request. </p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"FieldLevelEncryptionProfile"
},
"UpdatePublicKeyRequest":{
"type":"structure",
"required":[
"PublicKeyConfig",
"Id"
],
"members":{
"PublicKeyConfig":{
"shape":"PublicKeyConfig",
"documentation":"<p>Request to update public key information.</p>",
"locationName":"PublicKeyConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
},
"Id":{
"shape":"string",
"documentation":"<p>ID of the public key to be updated.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the public key to update. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"payload":"PublicKeyConfig"
},
"UpdatePublicKeyResult":{
"type":"structure",
"members":{
"PublicKey":{
"shape":"PublicKey",
"documentation":"<p>Return the results of updating the public key.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the update public key result. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"payload":"PublicKey"
},
"UpdateStreamingDistributionRequest":{
"type":"structure",
"required":[
"StreamingDistributionConfig",
"Id"
],
"members":{
"StreamingDistributionConfig":{
"shape":"StreamingDistributionConfig",
"documentation":"<p>The streaming distribution's configuration information.</p>",
"locationName":"StreamingDistributionConfig",
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"}
},
"Id":{
"shape":"string",
"documentation":"<p>The streaming distribution's id.</p>",
"location":"uri",
"locationName":"Id"
},
"IfMatch":{
"shape":"string",
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the streaming distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"If-Match"
}
},
"documentation":"<p>The request to update a streaming distribution.</p>",
"payload":"StreamingDistributionConfig"
},
"UpdateStreamingDistributionResult":{
"type":"structure",
"members":{
"StreamingDistribution":{
"shape":"StreamingDistribution",
"documentation":"<p>The streaming distribution's information.</p>"
},
"ETag":{
"shape":"string",
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"location":"header",
"locationName":"ETag"
}
},
"documentation":"<p>The returned result of the corresponding request.</p>",
"payload":"StreamingDistribution"
},
"ViewerCertificate":{
"type":"structure",
"members":{
"CloudFrontDefaultCertificate":{
"shape":"boolean",
"documentation":"<p>For information about how and when to use <code>CloudFrontDefaultCertificate</code>, see <a>ViewerCertificate</a>.</p>"
},
"IAMCertificateId":{
"shape":"string",
"documentation":"<p>For information about how and when to use <code>IAMCertificateId</code>, see <a>ViewerCertificate</a>.</p>"
},
"ACMCertificateArn":{
"shape":"string",
"documentation":"<p>For information about how and when to use <code>ACMCertificateArn</code>, see <a>ViewerCertificate</a>.</p>"
},
"SSLSupportMethod":{
"shape":"SSLSupportMethod",
"documentation":"<p>If you specify a value for <a>ViewerCertificate$ACMCertificateArn</a> or for <a>ViewerCertificate$IAMCertificateId</a>, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:</p> <ul> <li> <p> <code>vip</code>: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.</p> </li> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:</p> <ul> <li> <p>Use the <code>vip</code> option (dedicated IP addresses) instead of <code>sni-only</code>.</p> </li> <li> <p>Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, <code>https://d111111abcdef8.cloudfront.net/logo.png</code>.</p> </li> <li> <p>If you can control which browser your users use, upgrade the browser to one that supports SNI.</p> </li> <li> <p>Use HTTP instead of HTTPS.</p> </li> </ul> </li> </ul> <p>Don't specify a value for <code>SSLSupportMethod</code> if you specified <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS.html\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"MinimumProtocolVersion":{
"shape":"MinimumProtocolVersion",
"documentation":"<p>Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers</p> </li> <li> <p>The cipher that CloudFront uses to encrypt the content that it returns to viewers</p> </li> </ul> <note> <p>On the CloudFront console, this setting is called <b>Security policy</b>.</p> </note> <p>We recommend that you specify <code>TLSv1.1_2016</code> unless your users are using browsers or devices that do not support TLSv1.1 or later.</p> <p>When both of the following are true, you must specify <code>TLSv1</code> or later for the security policy: </p> <ul> <li> <p>You're using a custom certificate: you specified a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code> </p> </li> <li> <p>You're using SNI: you specified <code>sni-only</code> for <code>SSLSupportMethod</code> </p> </li> </ul> <p>If you specify <code>true</code> for <code>CloudFrontDefaultCertificate</code>, CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you specify for <code>MinimumProtocolVersion</code>.</p> <p>For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers\"> Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"Certificate":{
"shape":"string",
"documentation":"<p>This field has been deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul>",
"deprecated":true
},
"CertificateSource":{
"shape":"CertificateSource",
"documentation":"<p>This field has been deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul>",
"deprecated":true
}
},
"documentation":"<p>A complex type that specifies the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as <code>example.com</code> or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>You must specify only one of the following values: </p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul> <p>Don't specify <code>false</code> for <code>CloudFrontDefaultCertificate</code>.</p> <p> <b>If you want viewers to use HTTP instead of HTTPS to request your objects</b>: Specify the following value:</p> <p> <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;</code> </p> <p>In addition, specify <code>allow-all</code> for <code>ViewerProtocolPolicy</code> for all of your cache behaviors.</p> <p> <b>If you want viewers to use HTTPS to request your objects</b>: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:</p> <ul> <li> <p> <b>If you're using an alternate domain name, such as example.com</b>: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:</p> <ul> <li> <p> <code>&lt;ACMCertificateArn&gt;<i>ARN for ACM SSL/TLS certificate</i>&lt;ACMCertificateArn&gt;</code> where <code> <i>ARN for ACM SSL/TLS certificate</i> </code> is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> <li> <p> <code>&lt;IAMCertificateId&gt;<i>IAM certificate ID</i>&lt;IAMCertificateId&gt;</code> where <code> <i>IAM certificate ID</i> </code> is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p> <p>If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (<code>https://example.com/logo.jpg</code>). If you use the domain name that is associated with your CloudFront distribution (such as <code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>) and the viewer supports <code>SNI</code>, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for <code>SSLSupportMethod</code>:</p> <ul> <li> <p> <code>vip</code>: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.</p> </li> <li> <p> <code>sni-only</code>: CloudFront drops the connection with the browser without returning the object.</p> </li> </ul> </li> <li> <p> <b>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code> </b>: Specify the following value:</p> <p> <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt; </code> </p> </li> </ul> <p>If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:</p> <ul> <li> <p> <code> &lt;ViewerProtocolPolicy&gt;https-only&lt;ViewerProtocolPolicy&gt;</code> </p> </li> <li> <p> <code>&lt;ViewerProtocolPolicy&gt;redirect-to-https&lt;ViewerProtocolPolicy&gt;</code> </p> </li> </ul> <p>You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:</p> <ul> <li> <p> <code>&lt;OriginProtocolPolicy&gt;https-only&lt;OriginProtocolPolicy&gt; </code> </p> </li> <li> <p> <code>&lt;OriginProtocolPolicy&gt;match-viewer&lt;OriginProtocolPolicy&gt; </code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
},
"ViewerProtocolPolicy":{
"type":"string",
"enum":[
"allow-all",
"https-only",
"redirect-to-https"
]
},
"boolean":{"type":"boolean"},
"integer":{"type":"integer"},
"long":{"type":"long"},
"string":{"type":"string"},
"timestamp":{"type":"timestamp"}
},
"documentation":"<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the <i>Amazon CloudFront Developer Guide</i>.</p>"
}

47
botocore/data/cloudfront/2018-06-18/waiters-2.json Normal file
View file

@ -0,0 +1,47 @@
{
"version": 2,
"waiters": {
"DistributionDeployed": {
"delay": 60,
"operation": "GetDistribution",
"maxAttempts": 25,
"description": "Wait until a distribution is deployed.",
"acceptors": [
{
"expected": "Deployed",
"matcher": "path",
"state": "success",
"argument": "Distribution.Status"
}
]
},
"InvalidationCompleted": {
"delay": 20,
"operation": "GetInvalidation",
"maxAttempts": 30,
"description": "Wait until an invalidation has completed.",
"acceptors": [
{
"expected": "Completed",
"matcher": "path",
"state": "success",
"argument": "Invalidation.Status"
}
]
},
"StreamingDistributionDeployed": {
"delay": 60,
"operation": "GetStreamingDistribution",
"maxAttempts": 25,
"description": "Wait until a streaming distribution is deployed.",
"acceptors": [
{
"expected": "Deployed",
"matcher": "path",
"state": "success",
"argument": "StreamingDistribution.Status"
}
]
}
}
}

58
botocore/data/cloudhsmv2/2017-04-28/service-2.json
View file

@ -14,6 +14,22 @@
"uid":"cloudhsmv2-2017-04-28"
},
"operations":{
"CopyBackupToRegion":{
"name":"CopyBackupToRegion",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CopyBackupToRegionRequest"},
"output":{"shape":"CopyBackupToRegionResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"CreateCluster":{
"name":"CreateCluster",
"http":{
@ -204,7 +220,11 @@
"CreateTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the backup was created.</p>"
}
},
"CopyTimestamp":{"shape":"Timestamp"},
"SourceRegion":{"shape":"Region"},
"SourceBackup":{"shape":"BackupId"},
"SourceCluster":{"shape":"ClusterId"}
},
"documentation":"<p>Contains information about a backup of an AWS CloudHSM cluster.</p>"
},
@ -228,6 +248,7 @@
"type":"list",
"member":{"shape":"Backup"}
},
"Boolean":{"type":"boolean"},
"Cert":{
"type":"string",
"max":5000,
@ -380,6 +401,23 @@
"type":"list",
"member":{"shape":"Cluster"}
},
"CopyBackupToRegionRequest":{
"type":"structure",
"required":[
"DestinationRegion",
"BackupId"
],
"members":{
"DestinationRegion":{"shape":"Region"},
"BackupId":{"shape":"BackupId"}
}
},
"CopyBackupToRegionResponse":{
"type":"structure",
"members":{
"DestinationBackup":{"shape":"DestinationBackup"}
}
},
"CreateClusterRequest":{
"type":"structure",
"required":[
@ -504,7 +542,8 @@
"Filters":{
"shape":"Filters",
"documentation":"<p>One or more filters to limit the items returned in the response.</p> <p>Use the <code>backupIds</code> filter to return only the specified backups. Specify backups by their backup identifier (ID).</p> <p>Use the <code>clusterIds</code> filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).</p> <p>Use the <code>states</code> filter to return only backups that match the specified state.</p>"
}
},
"SortAscending":{"shape":"Boolean"}
}
},
"DescribeBackupsResponse":{
@ -550,13 +589,22 @@
}
}
},
"DestinationBackup":{
"type":"structure",
"members":{
"CreateTimestamp":{"shape":"Timestamp"},
"SourceRegion":{"shape":"Region"},
"SourceBackup":{"shape":"BackupId"},
"SourceCluster":{"shape":"ClusterId"}
}
},
"EniId":{
"type":"string",
"pattern":"eni-[0-9a-fA-F]{8,17}"
},
"ExternalAz":{
"type":"string",
"pattern":"[a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-\\d[a-z]"
"pattern":"[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d[a-z]"
},
"ExternalSubnetMapping":{
"type":"map",
@ -719,6 +767,10 @@
"max":32,
"min":7
},
"Region":{
"type":"string",
"pattern":"[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d"
},
"SecurityGroup":{
"type":"string",
"pattern":"sg-[0-9a-fA-F]"

23
botocore/data/codebuild/2016-10-06/service-2.json
View file

@ -415,6 +415,10 @@
"networkInterface":{
"shape":"NetworkInterface",
"documentation":"<p>Describes a network interface.</p>"
},
"encryptionKey":{
"shape":"NonEmptyString",
"documentation":"<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>"
}
},
"documentation":"<p>Information about a build.</p>"
@ -433,6 +437,14 @@
"md5sum":{
"shape":"String",
"documentation":"<p>The MD5 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>"
},
"overrideArtifactName":{
"shape":"WrapperBoolean",
"documentation":"<p> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </p>"
},
"encryptionDisabled":{
"shape":"WrapperBoolean",
"documentation":"<p> Information that tells you if encryption for build artifacts is disabled. </p>"
}
},
"documentation":"<p>Information about build output artifacts.</p>"
@ -535,7 +547,8 @@
"name",
"source",
"artifacts",
"environment"
"environment",
"serviceRole"
],
"members":{
"name":{
@ -1066,6 +1079,14 @@
"packaging":{
"shape":"ArtifactPackaging",
"documentation":"<p>The type of build output artifact to create, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.</p> </li> </ul> </li> </ul>"
},
"overrideArtifactName":{
"shape":"WrapperBoolean",
"documentation":"<p> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </p>"
},
"encryptionDisabled":{
"shape":"WrapperBoolean",
"documentation":"<p> Set to true if you do not want your output artifacts encrypted. This option is only valid if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException will be thrown. </p>"
}
},
"documentation":"<p>Information about the build output artifacts for the build project.</p>"

223
botocore/data/comprehend/2017-11-27/service-2.json
View file

@ -80,6 +80,23 @@
],
"documentation":"<p>Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each one.</p>"
},
"BatchDetectSyntax":{
"name":"BatchDetectSyntax",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDetectSyntaxRequest"},
"output":{"shape":"BatchDetectSyntaxResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"BatchSizeLimitExceededException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see <a>how-syntax</a>.</p>"
},
"DescribeDominantLanguageDetectionJob":{
"name":"DescribeDominantLanguageDetectionJob",
"http":{
@ -223,6 +240,22 @@
],
"documentation":"<p>Inspects text and returns an inference of the prevailing sentiment (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>). </p>"
},
"DetectSyntax":{
"name":"DetectSyntax",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetectSyntaxRequest"},
"output":{"shape":"DetectSyntaxResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Inspects text for syntax and the part of speech of words in the document. For more information, <a>how-syntax</a>.</p>"
},
"ListDominantLanguageDetectionJobs":{
"name":"ListDominantLanguageDetectionJobs",
"http":{
@ -391,7 +424,7 @@
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a dominant language detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
"documentation":"<p>Stops a dominant language detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
},
"StopEntitiesDetectionJob":{
"name":"StopEntitiesDetectionJob",
@ -406,7 +439,7 @@
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops an entities detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
"documentation":"<p>Stops an entities detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
},
"StopKeyPhrasesDetectionJob":{
"name":"StopKeyPhrasesDetectionJob",
@ -421,7 +454,7 @@
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a key phrases detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
"documentation":"<p>Stops a key phrases detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
},
"StopSentimentDetectionJob":{
"name":"StopSentimentDetectionJob",
@ -436,7 +469,7 @@
{"shape":"JobNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job will be marked for termination and put into the <code>STOPPING</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation will return a 400 Internal Request Exception. </p> <p>When a job is stopped, any document that has already been processed will be written to the output location.</p>"
"documentation":"<p>Stops a sentiment detection job in progress.</p> <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it is put into the <code>COMPLETED</code> state; otherwise the job is be stopped and put into the <code>STOPPED</code> state.</p> <p>If the job is in the <code>COMPLETED</code> or <code>FAILED</code> state when you call the <code>StopDominantLanguageDetectionJob</code> operation, the operation returns a 400 Internal Request Exception. </p> <p>When a job is stopped, any documents already processed are written to the output location.</p>"
}
},
"shapes":{
@ -630,6 +663,54 @@
}
}
},
"BatchDetectSyntaxItemResult":{
"type":"structure",
"members":{
"Index":{
"shape":"Integer",
"documentation":"<p>The zero-based index of the document in the input list.</p>"
},
"SyntaxTokens":{
"shape":"ListOfSyntaxTokens",
"documentation":"<p>The syntax tokens for the words in the document, one token for each word.</p>"
}
},
"documentation":"<p>The result of calling the operation. The operation returns one object that is successfully processed by the operation.</p>"
},
"BatchDetectSyntaxRequest":{
"type":"structure",
"required":[
"TextList",
"LanguageCode"
],
"members":{
"TextList":{
"shape":"StringList",
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
},
"LanguageCode":{
"shape":"SyntaxLanguageCode",
"documentation":"<p>The language of the input documents. You can specify English (\"en\") or Spanish (\"es\"). All documents must be in the same language.</p>"
}
}
},
"BatchDetectSyntaxResponse":{
"type":"structure",
"required":[
"ResultList",
"ErrorList"
],
"members":{
"ResultList":{
"shape":"ListOfDetectSyntaxResult",
"documentation":"<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
},
"ErrorList":{
"shape":"BatchItemErrorList",
"documentation":"<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
}
}
},
"BatchItemError":{
"type":"structure",
"members":{
@ -862,6 +943,32 @@
}
}
},
"DetectSyntaxRequest":{
"type":"structure",
"required":[
"Text",
"LanguageCode"
],
"members":{
"Text":{
"shape":"String",
"documentation":"<p>A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.</p>"
},
"LanguageCode":{
"shape":"SyntaxLanguageCode",
"documentation":"<p>The language code of the input documents. You can specify English (\"en\") or Spanish (\"es\").</p>"
}
}
},
"DetectSyntaxResponse":{
"type":"structure",
"members":{
"SyntaxTokens":{
"shape":"ListOfSyntaxTokens",
"documentation":"<p>A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see <a>how-syntax</a>.</p>"
}
}
},
"DominantLanguage":{
"type":"structure",
"members":{
@ -932,6 +1039,10 @@
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>The output data configuration that you supplied when you created the dominant language detection job.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.</p>"
}
},
"documentation":"<p>Provides information about a dominant language detection job.</p>"
@ -1000,6 +1111,10 @@
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the input documents.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.</p>"
}
},
"documentation":"<p>Provides information about an entities detection job.</p>"
@ -1213,6 +1328,10 @@
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the input documents.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.</p>"
}
},
"documentation":"<p>Provides information about a key phrases detection job.</p>"
@ -1334,6 +1453,10 @@
"type":"list",
"member":{"shape":"BatchDetectSentimentItemResult"}
},
"ListOfDetectSyntaxResult":{
"type":"list",
"member":{"shape":"BatchDetectSyntaxItemResult"}
},
"ListOfDominantLanguages":{
"type":"list",
"member":{"shape":"DominantLanguage"}
@ -1346,6 +1469,10 @@
"type":"list",
"member":{"shape":"KeyPhrase"}
},
"ListOfSyntaxTokens":{
"type":"list",
"member":{"shape":"SyntaxToken"}
},
"ListSentimentDetectionJobsRequest":{
"type":"structure",
"members":{
@ -1427,6 +1554,42 @@
},
"documentation":"<p>Provides configuration parameters for the output of topic detection jobs.</p> <p/>"
},
"PartOfSpeechTag":{
"type":"structure",
"members":{
"Tag":{
"shape":"PartOfSpeechTagType",
"documentation":"<p>Identifies the part of speech that the token represents.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The confidence that Amazon Comprehend has that the part of speech was correctly identified.</p>"
}
},
"documentation":"<p>Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see <a>how-syntax</a>.</p>"
},
"PartOfSpeechTagType":{
"type":"string",
"enum":[
"ADJ",
"ADP",
"ADV",
"AUX",
"CONJ",
"DET",
"INTJ",
"NOUN",
"NUM",
"O",
"PART",
"PRON",
"PROPN",
"PUNCT",
"SCONJ",
"SYM",
"VERB"
]
},
"S3Uri":{
"type":"string",
"max":1024,
@ -1492,6 +1655,10 @@
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language code of the input documents.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.</p>"
}
},
"documentation":"<p>Provides information about a sentiment detection job.</p>"
@ -1549,7 +1716,7 @@
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions\">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</p>"
},
"JobName":{
"shape":"JobName",
@ -1594,7 +1761,7 @@
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions\">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</p>"
},
"JobName":{
"shape":"JobName",
@ -1643,7 +1810,7 @@
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions\">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</p>"
},
"JobName":{
"shape":"JobName",
@ -1692,7 +1859,7 @@
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions\">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</p>"
},
"JobName":{
"shape":"JobName",
@ -1740,7 +1907,7 @@
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. </p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions\">https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions</a>.</p>"
},
"JobName":{
"shape":"JobName",
@ -1789,7 +1956,7 @@
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopDominantLanguageDetectionJob</code> operation.</p>"
"documentation":"<p>Either <code>STOP_REQUESTED</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopDominantLanguageDetectionJob</code> operation.</p>"
}
}
},
@ -1812,7 +1979,7 @@
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopEntitiesDetectionJob</code> operation.</p>"
"documentation":"<p>Either <code>STOP_REQUESTED</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopEntitiesDetectionJob</code> operation.</p>"
}
}
},
@ -1835,7 +2002,7 @@
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopKeyPhrasesDetectionJob</code> operation.</p>"
"documentation":"<p>Either <code>STOP_REQUESTED</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopKeyPhrasesDetectionJob</code> operation.</p>"
}
}
},
@ -1858,7 +2025,7 @@
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Either <code>STOPPING</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopSentimentDetectionJob</code> operation.</p>"
"documentation":"<p>Either <code>STOP_REQUESTED</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopSentimentDetectionJob</code> operation.</p>"
}
}
},
@ -1870,6 +2037,36 @@
"type":"list",
"member":{"shape":"String"}
},
"SyntaxLanguageCode":{
"type":"string",
"enum":["en"]
},
"SyntaxToken":{
"type":"structure",
"members":{
"TokenId":{
"shape":"Integer",
"documentation":"<p>A unique identifier for a token.</p>"
},
"Text":{
"shape":"String",
"documentation":"<p>The word that was recognized in the source text.</p>"
},
"BeginOffset":{
"shape":"Integer",
"documentation":"<p>The zero-based offset from the beginning of the source text to the first character in the word.</p>"
},
"EndOffset":{
"shape":"Integer",
"documentation":"<p>The zero-based offset from the beginning of the source text to the last character in the word.</p>"
},
"PartOfSpeech":{
"shape":"PartOfSpeechTag",
"documentation":"<p>Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see <a>how-syntax</a>.</p>"
}
},
"documentation":"<p>Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.</p>"
},
"TextSizeLimitExceededException":{
"type":"structure",
"members":{

6
botocore/data/config/2014-11-12/service-2.json
View file

@ -3069,7 +3069,11 @@
},
"ResourceCreationTime":{"type":"timestamp"},
"ResourceDeletionTime":{"type":"timestamp"},
"ResourceId":{"type":"string"},
"ResourceId":{
"type":"string",
"max":768,
"min":1
},
"ResourceIdList":{
"type":"list",
"member":{"shape":"ResourceId"}

1130
botocore/data/connect/2017-08-08/service-2.json
View file

@ -13,6 +13,178 @@
"uid":"connect-2017-08-08"
},
"operations":{
"CreateUser":{
"name":"CreateUser",
"http":{
"method":"PUT",
"requestUri":"/users/{InstanceId}"
},
"input":{"shape":"CreateUserRequest"},
"output":{"shape":"CreateUserResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"LimitExceededException"},
{"shape":"DuplicateResourceException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Creates a new user account in your Amazon Connect instance.</p>"
},
"DeleteUser":{
"name":"DeleteUser",
"http":{
"method":"DELETE",
"requestUri":"/users/{InstanceId}/{UserId}"
},
"input":{"shape":"DeleteUserRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Deletes a user account from Amazon Connect.</p>"
},
"DescribeUser":{
"name":"DescribeUser",
"http":{
"method":"GET",
"requestUri":"/users/{InstanceId}/{UserId}"
},
"input":{"shape":"DescribeUserRequest"},
"output":{"shape":"DescribeUserResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns a <code>User</code> object that contains information about the user account specified by the <code>UserId</code>.</p>"
},
"DescribeUserHierarchyGroup":{
"name":"DescribeUserHierarchyGroup",
"http":{
"method":"GET",
"requestUri":"/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}"
},
"input":{"shape":"DescribeUserHierarchyGroupRequest"},
"output":{"shape":"DescribeUserHierarchyGroupResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns a <code>HierarchyGroup</code> object that includes information about a hierarchy group in your instance.</p>"
},
"DescribeUserHierarchyStructure":{
"name":"DescribeUserHierarchyStructure",
"http":{
"method":"GET",
"requestUri":"/user-hierarchy-structure/{InstanceId}"
},
"input":{"shape":"DescribeUserHierarchyStructureRequest"},
"output":{"shape":"DescribeUserHierarchyStructureResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns a <code>HiearchyGroupStructure</code> object, which contains data about the levels in the agent hierarchy.</p>"
},
"GetFederationToken":{
"name":"GetFederationToken",
"http":{
"method":"GET",
"requestUri":"/user/federate/{InstanceId}"
},
"input":{"shape":"GetFederationTokenRequest"},
"output":{"shape":"GetFederationTokenResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UserNotFoundException"},
{"shape":"InternalServiceException"},
{"shape":"DuplicateResourceException"}
],
"documentation":"<p>Retrieves a token for federation.</p>"
},
"ListRoutingProfiles":{
"name":"ListRoutingProfiles",
"http":{
"method":"GET",
"requestUri":"/routing-profiles-summary/{InstanceId}"
},
"input":{"shape":"ListRoutingProfilesRequest"},
"output":{"shape":"ListRoutingProfilesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns an array of <code>RoutingProfileSummary</code> objects that includes information about the routing profiles in your instance.</p>"
},
"ListSecurityProfiles":{
"name":"ListSecurityProfiles",
"http":{
"method":"GET",
"requestUri":"/security-profiles-summary/{InstanceId}"
},
"input":{"shape":"ListSecurityProfilesRequest"},
"output":{"shape":"ListSecurityProfilesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.</p>"
},
"ListUserHierarchyGroups":{
"name":"ListUserHierarchyGroups",
"http":{
"method":"GET",
"requestUri":"/user-hierarchy-groups-summary/{InstanceId}"
},
"input":{"shape":"ListUserHierarchyGroupsRequest"},
"output":{"shape":"ListUserHierarchyGroupsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns a <code>UserHierarchyGroupSummaryList</code>, which is an array of <code>HierarchyGroupSummary</code> objects that contain information about the hierarchy groups in your instance.</p>"
},
"ListUsers":{
"name":"ListUsers",
"http":{
"method":"GET",
"requestUri":"/users-summary/{InstanceId}"
},
"input":{"shape":"ListUsersRequest"},
"output":{"shape":"ListUsersResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Returns a <code>UserSummaryList</code>, which is an array of <code>UserSummary</code> objects.</p>"
},
"StartOutboundVoiceContact":{
"name":"StartOutboundVoiceContact",
"http":{
@ -30,7 +202,7 @@
{"shape":"DestinationNotAllowedException"},
{"shape":"OutboundContactNotPermittedException"}
],
"documentation":"<p>The <code>StartOutboundVoiceContact</code> operation initiates a contact flow to place an outbound call to a customer.</p> <p>There is a throttling limit placed on usage of the API that includes a <code>RateLimit</code> of 2 per second, and a <code>BurstLimit</code> of 5 per second.</p> <p>If you are using an IAM account, it must have permissions to the <code>connect:StartOutboundVoiceContact</code> action.</p>"
"documentation":"<p>The <code>StartOutboundVoiceContact</code> operation initiates a contact flow to place an outbound call to a customer.</p> <p>There is a throttling limit placed on usage of the API that includes a RateLimit of 2 per second, and a BurstLimit of 5 per second.</p> <p>If you are using an IAM account, it must have permission to the <code>connect:StartOutboundVoiceContact</code> action.</p>"
},
"StopContact":{
"name":"StopContact",
@ -47,10 +219,111 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Ends the contact initiated by the <code>StartOutboundVoiceContact</code> operation.</p> <p>If you are using an IAM account, it must have permissions to the <code>connect:StopContact</code> operation.</p>"
"documentation":"<p>Ends the contact initiated by the <code>StartOutboundVoiceContact</code> operation.</p> <p>If you are using an IAM account, it must have permission to the <code>connect:StopContact</code> action.</p>"
},
"UpdateUserHierarchy":{
"name":"UpdateUserHierarchy",
"http":{
"method":"POST",
"requestUri":"/users/{InstanceId}/{UserId}/hierarchy"
},
"input":{"shape":"UpdateUserHierarchyRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Assigns the specified hierarchy group to the user.</p>"
},
"UpdateUserIdentityInfo":{
"name":"UpdateUserIdentityInfo",
"http":{
"method":"POST",
"requestUri":"/users/{InstanceId}/{UserId}/identity-info"
},
"input":{"shape":"UpdateUserIdentityInfoRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Updates the identity information for the specified user in a <code>UserIdentityInfo</code> object, including email, first name, and last name.</p>"
},
"UpdateUserPhoneConfig":{
"name":"UpdateUserPhoneConfig",
"http":{
"method":"POST",
"requestUri":"/users/{InstanceId}/{UserId}/phone-config"
},
"input":{"shape":"UpdateUserPhoneConfigRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Updates the phone configuration settings in the <code>UserPhoneConfig</code> object for the specified user.</p>"
},
"UpdateUserRoutingProfile":{
"name":"UpdateUserRoutingProfile",
"http":{
"method":"POST",
"requestUri":"/users/{InstanceId}/{UserId}/routing-profile"
},
"input":{"shape":"UpdateUserRoutingProfileRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Assigns the specified routing profile to a user.</p>"
},
"UpdateUserSecurityProfiles":{
"name":"UpdateUserSecurityProfiles",
"http":{
"method":"POST",
"requestUri":"/users/{InstanceId}/{UserId}/security-profiles"
},
"input":{"shape":"UpdateUserSecurityProfilesRequest"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Update the security profiles assigned to the user.</p>"
}
},
"shapes":{
"ARN":{"type":"string"},
"AfterContactWorkTimeLimit":{
"type":"integer",
"min":0
},
"AgentFirstName":{
"type":"string",
"max":100,
"min":1
},
"AgentLastName":{
"type":"string",
"max":100,
"min":1
},
"AgentUsername":{
"type":"string",
"max":20,
"min":1,
"pattern":"[a-zA-Z0-9\\_\\-\\.]+"
},
"AttributeName":{
"type":"string",
"documentation":"Key for the key value pair to be used for additional attributes.",
@ -69,6 +342,7 @@
"value":{"shape":"AttributeValue"},
"documentation":"Additional attributes can be provided in the request using this field. This will be passed to the contact flow execution. Client can make use of this additional info in their contact flow."
},
"AutoAccept":{"type":"boolean"},
"ClientToken":{
"type":"string",
"documentation":"Dedupe token to be provided by the client. This token is used to avoid duplicate calls to the customer.",
@ -97,6 +371,193 @@
"error":{"httpStatusCode":410},
"exception":true
},
"CreateUserRequest":{
"type":"structure",
"required":[
"Username",
"PhoneConfig",
"SecurityProfileIds",
"RoutingProfileId",
"InstanceId"
],
"members":{
"Username":{
"shape":"AgentUsername",
"documentation":"<p>The user name in Amazon Connect for the user to create.</p>"
},
"Password":{
"shape":"Password",
"documentation":"<p>The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an <code>InvalidRequestException</code> is returned.</p>"
},
"IdentityInfo":{
"shape":"UserIdentityInfo",
"documentation":"<p>Information about the user, including email address, first name, and last name.</p>"
},
"PhoneConfig":{
"shape":"UserPhoneConfig",
"documentation":"<p>Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.</p>"
},
"DirectoryUserId":{
"shape":"DirectoryUserId",
"documentation":"<p>The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the <code>DirectoryUserId</code> to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing directory.</p> <p>This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an <code>InvalidRequestException</code> is returned.</p>"
},
"SecurityProfileIds":{
"shape":"SecurityProfileIds",
"documentation":"<p>The unique identifier of the security profile to assign to the user created.</p>"
},
"RoutingProfileId":{
"shape":"RoutingProfileId",
"documentation":"<p>The unique identifier for the routing profile to assign to the user created.</p>"
},
"HierarchyGroupId":{
"shape":"HierarchyGroupId",
"documentation":"<p>The unique identifier for the hierarchy group to assign to the user created.</p>"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"CreateUserResponse":{
"type":"structure",
"members":{
"UserId":{
"shape":"UserId",
"documentation":"<p>The unique identifier for the user account in Amazon Connect</p>"
},
"UserArn":{
"shape":"ARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the user account created.</p>"
}
}
},
"Credentials":{
"type":"structure",
"members":{
"AccessToken":{
"shape":"SecurityToken",
"documentation":"<p>An access token generated for a federated user to access Amazon Connect</p>"
},
"AccessTokenExpiration":{
"shape":"timestamp",
"documentation":"<p>A token generated with an expiration time for the session a user is logged in to Amazon Connect</p>"
},
"RefreshToken":{
"shape":"SecurityToken",
"documentation":"<p>Renews a token generated for a user to access the Amazon Connect instance.</p>"
},
"RefreshTokenExpiration":{
"shape":"timestamp",
"documentation":"<p>Renews the expiration timer for a generated token.</p>"
}
},
"documentation":"<p>The credentials to use for federation.</p>"
},
"DeleteUserRequest":{
"type":"structure",
"required":[
"InstanceId",
"UserId"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"UserId":{
"shape":"UserId",
"documentation":"<p>The unique identifier of the user to delete.</p>",
"location":"uri",
"locationName":"UserId"
}
}
},
"DescribeUserHierarchyGroupRequest":{
"type":"structure",
"required":[
"HierarchyGroupId",
"InstanceId"
],
"members":{
"HierarchyGroupId":{
"shape":"HierarchyGroupId",
"documentation":"<p>The identifier for the hierarchy group to return.</p>",
"location":"uri",
"locationName":"HierarchyGroupId"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"DescribeUserHierarchyGroupResponse":{
"type":"structure",
"members":{
"HierarchyGroup":{
"shape":"HierarchyGroup",
"documentation":"<p>Returns a <code>HierarchyGroup</code> object.</p>"
}
}
},
"DescribeUserHierarchyStructureRequest":{
"type":"structure",
"required":["InstanceId"],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"DescribeUserHierarchyStructureResponse":{
"type":"structure",
"members":{
"HierarchyStructure":{
"shape":"HierarchyStructure",
"documentation":"<p>A <code>HierarchyStructure</code> object.</p>"
}
}
},
"DescribeUserRequest":{
"type":"structure",
"required":[
"UserId",
"InstanceId"
],
"members":{
"UserId":{
"shape":"UserId",
"documentation":"<p>Unique identifier for the user account to return.</p>",
"location":"uri",
"locationName":"UserId"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"DescribeUserResponse":{
"type":"structure",
"members":{
"User":{
"shape":"User",
"documentation":"<p>A <code>User</code> object that contains information about the user account and configuration settings.</p>"
}
}
},
"DestinationNotAllowedException":{
"type":"structure",
"members":{
@ -105,13 +566,169 @@
"documentation":"<p>The message.</p>"
}
},
"documentation":"<p>Outbound calls to the destination number are not allowed for your instance. You can request that the country be included in the allowed countries for your instance by submitting a <a href=\"https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase\">Service Limit Increase</a>.</p>",
"documentation":"<p>Outbound calls to the destination number are not allowed.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"DirectoryUserId":{"type":"string"},
"DuplicateResourceException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"documentation":"<p>A resource with that name already exisits.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"Email":{"type":"string"},
"GetFederationTokenRequest":{
"type":"structure",
"required":["InstanceId"],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"GetFederationTokenResponse":{
"type":"structure",
"members":{
"Credentials":{
"shape":"Credentials",
"documentation":"<p>The credentials to use for federation.</p>"
}
}
},
"HierarchyGroup":{
"type":"structure",
"members":{
"Id":{
"shape":"HierarchyGroupId",
"documentation":"<p>The identifier for the hierarchy group.</p>"
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The Amazon Resource Name (ARN) for the hierarchy group.</p>"
},
"Name":{
"shape":"HierarchyGroupName",
"documentation":"<p>The name of the hierarchy group in your instance.</p>"
},
"LevelId":{
"shape":"HierarchyLevelId",
"documentation":"<p>The identifier for the level in the hierarchy group.</p>"
},
"HierarchyPath":{
"shape":"HierarchyPath",
"documentation":"<p>A <code>HierarchyPath</code> object that contains information about the levels in the hierarchy group.</p>"
}
},
"documentation":"<p>A <code>HierarchyGroup</code> object that contains information about a hierarchy group in your Amazon Connect instance.</p>"
},
"HierarchyGroupId":{"type":"string"},
"HierarchyGroupName":{"type":"string"},
"HierarchyGroupSummary":{
"type":"structure",
"members":{
"Id":{
"shape":"HierarchyGroupId",
"documentation":"<p>The identifier of the hierarchy group.</p>"
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The ARN for the hierarchy group.</p>"
},
"Name":{
"shape":"HierarchyGroupName",
"documentation":"<p>The name of the hierarchy group.</p>"
}
},
"documentation":"<p>A <code>HierarchyGroupSummary</code> object that contains information about the hierarchy group, including ARN, Id, and Name.</p>"
},
"HierarchyGroupSummaryList":{
"type":"list",
"member":{"shape":"HierarchyGroupSummary"}
},
"HierarchyLevel":{
"type":"structure",
"members":{
"Id":{
"shape":"HierarchyLevelId",
"documentation":"<p>The identifier for the hierarchy group level.</p>"
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The ARN for the hierarchy group level.</p>"
},
"Name":{
"shape":"HierarchyLevelName",
"documentation":"<p>The name of the hierarchy group level.</p>"
}
},
"documentation":"<p>A <code>HierarchyLevel</code> object that contains information about the levels in a hierarchy group, including ARN, Id, and Name.</p>"
},
"HierarchyLevelId":{"type":"string"},
"HierarchyLevelName":{"type":"string"},
"HierarchyPath":{
"type":"structure",
"members":{
"LevelOne":{
"shape":"HierarchyGroupSummary",
"documentation":"<p>A <code>HierarchyGroupSummary</code> object that contains information about the level of the hierarchy group, including ARN, Id, and Name.</p>"
},
"LevelTwo":{
"shape":"HierarchyGroupSummary",
"documentation":"<p>A <code>HierarchyGroupSummary</code> object that contains information about the level of the hierarchy group, including ARN, Id, and Name.</p>"
},
"LevelThree":{
"shape":"HierarchyGroupSummary",
"documentation":"<p>A <code>HierarchyGroupSummary</code> object that contains information about the level of the hierarchy group, including ARN, Id, and Name.</p>"
},
"LevelFour":{
"shape":"HierarchyGroupSummary",
"documentation":"<p>A <code>HierarchyGroupSummary</code> object that contains information about the level of the hierarchy group, including ARN, Id, and Name.</p>"
},
"LevelFive":{
"shape":"HierarchyGroupSummary",
"documentation":"<p>A <code>HierarchyGroupSummary</code> object that contains information about the level of the hierarchy group, including ARN, Id, and Name.</p>"
}
},
"documentation":"<p>A <code>HierarchyPath</code> object that contains information about the levels of the hierarchy group.</p>"
},
"HierarchyStructure":{
"type":"structure",
"members":{
"LevelOne":{
"shape":"HierarchyLevel",
"documentation":"<p>A <code>HierarchyLevel</code> object that contains information about the hierarchy group level.</p>"
},
"LevelTwo":{
"shape":"HierarchyLevel",
"documentation":"<p>A <code>HierarchyLevel</code> object that contains information about the hierarchy group level.</p>"
},
"LevelThree":{
"shape":"HierarchyLevel",
"documentation":"<p>A <code>HierarchyLevel</code> object that contains information about the hierarchy group level.</p>"
},
"LevelFour":{
"shape":"HierarchyLevel",
"documentation":"<p>A <code>HierarchyLevel</code> object that contains information about the hierarchy group level.</p>"
},
"LevelFive":{
"shape":"HierarchyLevel",
"documentation":"<p>A <code>HierarchyLevel</code> object that contains information about the hierarchy group level.</p>"
}
},
"documentation":"<p>A <code>HierarchyStructure</code> object that contains information about the hierarchy group structure.</p>"
},
"InstanceId":{
"type":"string",
"documentation":"Amazon Connect Organization ARN. A client must provide its organization ARN in order to place a call. This defines the call from organization."
"documentation":"Amazon Connect Organization ARN. A client must provide its organization ARN in order to place a call. This defines the call from organization.",
"max":100,
"min":1
},
"InternalServiceException":{
"type":"structure",
@ -161,7 +778,165 @@
"error":{"httpStatusCode":429},
"exception":true
},
"ListRoutingProfilesRequest":{
"type":"structure",
"required":["InstanceId"],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximum number of routing profiles to return in the response.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListRoutingProfilesResponse":{
"type":"structure",
"members":{
"RoutingProfileSummaryList":{
"shape":"RoutingProfileSummaryList",
"documentation":"<p>An array of <code>RoutingProfileSummary</code> objects that include the ARN, Id, and Name of the routing profile.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.</p>"
}
}
},
"ListSecurityProfilesRequest":{
"type":"structure",
"required":["InstanceId"],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximum number of security profiles to return.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListSecurityProfilesResponse":{
"type":"structure",
"members":{
"SecurityProfileSummaryList":{
"shape":"SecurityProfileSummaryList",
"documentation":"<p>An array of <code>SecurityProfileSummary</code> objects.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.</p>"
}
}
},
"ListUserHierarchyGroupsRequest":{
"type":"structure",
"required":["InstanceId"],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximum number of hierarchy groups to return.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListUserHierarchyGroupsResponse":{
"type":"structure",
"members":{
"UserHierarchyGroupSummaryList":{
"shape":"HierarchyGroupSummaryList",
"documentation":"<p>An array of <code>HierarchyGroupSummary</code> objects.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.</p>"
}
}
},
"ListUsersRequest":{
"type":"structure",
"required":["InstanceId"],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResult1000",
"documentation":"<p>The maximum number of results to return in the response.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListUsersResponse":{
"type":"structure",
"members":{
"UserSummaryList":{
"shape":"UserSummaryList",
"documentation":"<p>An array of <code>UserSummary</code> objects that contain information about the users in your instance.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.</p>"
}
}
},
"MaxResult1000":{
"type":"integer",
"max":1000,
"min":1
},
"Message":{"type":"string"},
"NextToken":{"type":"string"},
"OutboundContactNotPermittedException":{
"type":"structure",
"members":{
@ -170,14 +945,25 @@
"documentation":"<p>The message.</p>"
}
},
"documentation":"<p>The contact is not permitted because outbound calling is not enabled for the instance.</p>",
"documentation":"<p>The contact is not permitted.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"Password":{
"type":"string",
"pattern":"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,}$/"
},
"PhoneNumber":{
"type":"string",
"documentation":"End customer's phone number to call."
},
"PhoneType":{
"type":"string",
"enum":[
"SOFT_PHONE",
"DESK_PHONE"
]
},
"QueueId":{
"type":"string",
"documentation":"Identifier of the queue to be used for the contact routing."
@ -194,6 +980,68 @@
"error":{"httpStatusCode":404},
"exception":true
},
"RoutingProfileId":{"type":"string"},
"RoutingProfileName":{
"type":"string",
"max":100,
"min":1
},
"RoutingProfileSummary":{
"type":"structure",
"members":{
"Id":{
"shape":"RoutingProfileId",
"documentation":"<p>The identifier of the routing profile.</p>"
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The ARN of the routing profile.</p>"
},
"Name":{
"shape":"RoutingProfileName",
"documentation":"<p>The name of the routing profile.</p>"
}
},
"documentation":"<p>A <code>RoutingProfileSummary</code> object that contains information about a routing profile, including ARN, Id, and Name.</p>"
},
"RoutingProfileSummaryList":{
"type":"list",
"member":{"shape":"RoutingProfileSummary"}
},
"SecurityProfileId":{"type":"string"},
"SecurityProfileIds":{
"type":"list",
"member":{"shape":"SecurityProfileId"},
"max":10,
"min":1
},
"SecurityProfileName":{"type":"string"},
"SecurityProfileSummary":{
"type":"structure",
"members":{
"Id":{
"shape":"SecurityProfileId",
"documentation":"<p>The identifier of the security profile.</p>"
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The ARN of the security profile.</p>"
},
"Name":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile.</p>"
}
},
"documentation":"<p>A <code>SecurityProfileSummary</code> object that contains information about a security profile, including ARN, Id, Name.</p>"
},
"SecurityProfileSummaryList":{
"type":"list",
"member":{"shape":"SecurityProfileSummary"}
},
"SecurityToken":{
"type":"string",
"sensitive":true
},
"StartOutboundVoiceContactRequest":{
"type":"structure",
"required":[
@ -204,15 +1052,15 @@
"members":{
"DestinationPhoneNumber":{
"shape":"PhoneNumber",
"documentation":"<p>The phone number, in E.164 format, of the customer to call with the outbound contact.</p>"
"documentation":"<p>The phone number of the customer in E.164 format.</p>"
},
"ContactFlowId":{
"shape":"ContactFlowId",
"documentation":"<p>The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.</p> <p>To find the <code>ContactFlowId</code>, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: <code>https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/<i>b0b8f2dd-ed1b-4c44-af36-ce189a178181</i> </code>. At the end of the URL, you see <code>contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181</code>. The <code>ContactFlowID</code> for this contact flow is <code> <i>b0b8f2dd-ed1b-4c44-af36-ce189a178181</i> </code>. Make sure to include only the GUID after the \"contact-flow/\" in your requests.</p>"
"documentation":"<p>The identifier for the contact flow to connect the outbound call to.</p> <p>To find the <code>ContactFlowId</code>, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as <code>78ea8fd5-2659-4f2b-b528-699760ccfc1b</code>.</p>"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the <code>InstanceId</code> value for your Amazon Connect instance, open the <a href=\"https://console.aws.amazon.com/connect/\">Amazon Connect console</a>. Select the instance alias of the instance and view the instance ID in the <b>Overview</b> section. For example, the instance ID is the set of characters at the end of the instance ARN, after \"instance/\", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>"
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>"
},
"ClientToken":{
"shape":"ClientToken",
@ -221,15 +1069,15 @@
},
"SourcePhoneNumber":{
"shape":"PhoneNumber",
"documentation":"<p>The phone number, in E.164 format, associated with your Amazon Connect instance to use to place the outbound call.</p>"
"documentation":"<p>The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.</p>"
},
"QueueId":{
"shape":"QueueId",
"documentation":"<p>The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by <code>ContactFlowId</code>.</p> <p>To find the <code>QueueId</code>, open the queue to use in the Amazon Connect queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the <code>QueueId</code> value is the set of characters at the end of the URL, after \"queue/\", such as <code>aeg40574-2d01-51c3-73d6-bf8624d2168c</code>.</p>"
"documentation":"<p>The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow.</p> <p>To find the <code>QueueId</code>, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as <code>queue/aeg40574-2d01-51c3-73d6-bf8624d2168c</code>.</p>"
},
"Attributes":{
"shape":"Attributes",
"documentation":"<p>Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.</p> <p>For example, to play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:</p>"
"documentation":"<p>Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.</p> <p>For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:</p>"
}
}
},
@ -251,11 +1099,11 @@
"members":{
"ContactId":{
"shape":"ContactId",
"documentation":"<p>The unique identifier of the contact to end. This is the <code>ContactId</code> value returned from the <code>StartOutboundVoiceContact</code> operation.</p>"
"documentation":"<p>The unique identifier of the contact to end.</p>"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier of the Amazon Connect instance in which the contact is active.</p>"
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>"
}
}
},
@ -263,7 +1111,261 @@
"type":"structure",
"members":{
}
}
},
"ThrottlingException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"documentation":"<p>The throttling limit has been exceeded.</p>",
"error":{"httpStatusCode":429},
"exception":true
},
"UpdateUserHierarchyRequest":{
"type":"structure",
"required":[
"UserId",
"InstanceId"
],
"members":{
"HierarchyGroupId":{
"shape":"HierarchyGroupId",
"documentation":"<p>The identifier for the hierarchy group to assign to the user.</p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p>The identifier of the user account to assign the hierarchy group to.</p>",
"location":"uri",
"locationName":"UserId"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"UpdateUserIdentityInfoRequest":{
"type":"structure",
"required":[
"IdentityInfo",
"UserId",
"InstanceId"
],
"members":{
"IdentityInfo":{
"shape":"UserIdentityInfo",
"documentation":"<p>A <code>UserIdentityInfo</code> object.</p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p>The identifier for the user account to update identity information for.</p>",
"location":"uri",
"locationName":"UserId"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"UpdateUserPhoneConfigRequest":{
"type":"structure",
"required":[
"PhoneConfig",
"UserId",
"InstanceId"
],
"members":{
"PhoneConfig":{
"shape":"UserPhoneConfig",
"documentation":"<p>A <code>UserPhoneConfig</code> object that contains settings for <code>AfterContactWorkTimeLimit</code>, <code>AutoAccept</code>, <code>DeskPhoneNumber</code>, and <code>PhoneType</code> to assign to the user.</p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p>The identifier for the user account to change phone settings for.</p>",
"location":"uri",
"locationName":"UserId"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"UpdateUserRoutingProfileRequest":{
"type":"structure",
"required":[
"RoutingProfileId",
"UserId",
"InstanceId"
],
"members":{
"RoutingProfileId":{
"shape":"RoutingProfileId",
"documentation":"<p>The identifier of the routing profile to assign to the user.</p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p>The identifier for the user account to assign the routing profile to.</p>",
"location":"uri",
"locationName":"UserId"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"UpdateUserSecurityProfilesRequest":{
"type":"structure",
"required":[
"SecurityProfileIds",
"UserId",
"InstanceId"
],
"members":{
"SecurityProfileIds":{
"shape":"SecurityProfileIds",
"documentation":"<p>The identifiers for the security profiles to assign to the user.</p>"
},
"UserId":{
"shape":"UserId",
"documentation":"<p>The identifier of the user account to assign the security profiles.</p>",
"location":"uri",
"locationName":"UserId"
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"location":"uri",
"locationName":"InstanceId"
}
}
},
"User":{
"type":"structure",
"members":{
"Id":{
"shape":"UserId",
"documentation":"<p>The identifier of the user account.</p>"
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The ARN of the user account.</p>"
},
"Username":{
"shape":"AgentUsername",
"documentation":"<p>The user name assigned to the user account.</p>"
},
"IdentityInfo":{
"shape":"UserIdentityInfo",
"documentation":"<p>A <code>UserIdentityInfo</code> object.</p>"
},
"PhoneConfig":{
"shape":"UserPhoneConfig",
"documentation":"<p>A <code>UserPhoneConfig</code> object.</p>"
},
"DirectoryUserId":{
"shape":"DirectoryUserId",
"documentation":"<p>The directory Id for the user account in the existing directory used for identity management.</p>"
},
"SecurityProfileIds":{
"shape":"SecurityProfileIds",
"documentation":"<p>The identifier(s) for the security profile assigned to the user.</p>"
},
"RoutingProfileId":{
"shape":"RoutingProfileId",
"documentation":"<p>The identifier of the routing profile assigned to the user.</p>"
},
"HierarchyGroupId":{
"shape":"HierarchyGroupId",
"documentation":"<p>The identifier for the hierarchy group assigned to the user.</p>"
}
},
"documentation":"<p>A <code>User</code> object that contains information about a user account in your Amazon Connect instance, including configuration settings.</p>"
},
"UserId":{"type":"string"},
"UserIdentityInfo":{
"type":"structure",
"members":{
"FirstName":{
"shape":"AgentFirstName",
"documentation":"<p>The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.</p>"
},
"LastName":{
"shape":"AgentLastName",
"documentation":"<p>The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.</p>"
},
"Email":{
"shape":"Email",
"documentation":"<p>The email address added to the user account. If you are using SAML for identity management and include this parameter, an <code>InvalidRequestException</code> is returned.</p>"
}
},
"documentation":"<p>A <code>UserIdentityInfo</code> object that contains information about the user's identity, including email address, first name, and last name.</p>"
},
"UserNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"documentation":"<p>No user with the specified credentials was found in the Amazon Connect instance.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"UserPhoneConfig":{
"type":"structure",
"required":["PhoneType"],
"members":{
"PhoneType":{
"shape":"PhoneType",
"documentation":"<p>The phone type selected for the user, either Soft phone or Desk phone.</p>"
},
"AutoAccept":{
"shape":"AutoAccept",
"documentation":"<p>The Auto accept setting for the user, Yes or No.</p>"
},
"AfterContactWorkTimeLimit":{
"shape":"AfterContactWorkTimeLimit",
"documentation":"<p>The After Call Work (ACW) timeout setting, in seconds, for the user.</p>"
},
"DeskPhoneNumber":{
"shape":"PhoneNumber",
"documentation":"<p>The phone number for the user's desk phone.</p>"
}
},
"documentation":"<p>A <code>UserPhoneConfig</code> object that contains information about the user phone configuration settings.</p>"
},
"UserSummary":{
"type":"structure",
"members":{
"Id":{
"shape":"UserId",
"documentation":"<p>The identifier for the user account.</p>"
},
"Arn":{
"shape":"ARN",
"documentation":"<p>The ARN for the user account.</p>"
},
"Username":{
"shape":"AgentUsername",
"documentation":"<p>The Amazon Connect user name for the user account.</p>"
}
},
"documentation":"<p>A <code>UserSummary</code> object that contains Information about a user, including ARN, Id, and user name.</p>"
},
"UserSummaryList":{
"type":"list",
"member":{"shape":"UserSummary"}
},
"timestamp":{"type":"timestamp"}
},
"documentation":"<p>The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p>"
}

83
botocore/data/dax/2017-04-19/service-2.json
View file

@ -33,6 +33,7 @@
{"shape":"NodeQuotaForCustomerExceededFault"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"TagQuotaPerResourceExceeded"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -50,6 +51,7 @@
{"shape":"ParameterGroupQuotaExceededFault"},
{"shape":"ParameterGroupAlreadyExistsFault"},
{"shape":"InvalidParameterGroupStateFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -67,7 +69,8 @@
{"shape":"SubnetGroupAlreadyExistsFault"},
{"shape":"SubnetGroupQuotaExceededFault"},
{"shape":"SubnetQuotaExceededFault"},
{"shape":"InvalidSubnet"}
{"shape":"InvalidSubnet"},
{"shape":"ServiceLinkedRoleNotFoundFault"}
],
"documentation":"<p>Creates a new subnet group.</p>"
},
@ -83,6 +86,7 @@
{"shape":"ClusterNotFoundFault"},
{"shape":"NodeNotFoundFault"},
{"shape":"InvalidClusterStateFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -99,6 +103,7 @@
"errors":[
{"shape":"ClusterNotFoundFault"},
{"shape":"InvalidClusterStateFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -115,6 +120,7 @@
"errors":[
{"shape":"InvalidParameterGroupStateFault"},
{"shape":"ParameterGroupNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -130,7 +136,8 @@
"output":{"shape":"DeleteSubnetGroupResponse"},
"errors":[
{"shape":"SubnetGroupInUseFault"},
{"shape":"SubnetGroupNotFoundFault"}
{"shape":"SubnetGroupNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"}
],
"documentation":"<p>Deletes a subnet group.</p> <note> <p>You cannot delete a subnet group if it is associated with any DAX clusters.</p> </note>"
},
@ -144,6 +151,7 @@
"output":{"shape":"DescribeClustersResponse"},
"errors":[
{"shape":"ClusterNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -158,6 +166,7 @@
"input":{"shape":"DescribeDefaultParametersRequest"},
"output":{"shape":"DescribeDefaultParametersResponse"},
"errors":[
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -172,6 +181,7 @@
"input":{"shape":"DescribeEventsRequest"},
"output":{"shape":"DescribeEventsResponse"},
"errors":[
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -187,6 +197,7 @@
"output":{"shape":"DescribeParameterGroupsResponse"},
"errors":[
{"shape":"ParameterGroupNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -202,6 +213,7 @@
"output":{"shape":"DescribeParametersResponse"},
"errors":[
{"shape":"ParameterGroupNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -216,7 +228,8 @@
"input":{"shape":"DescribeSubnetGroupsRequest"},
"output":{"shape":"DescribeSubnetGroupsResponse"},
"errors":[
{"shape":"SubnetGroupNotFoundFault"}
{"shape":"SubnetGroupNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"}
],
"documentation":"<p>Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.</p>"
},
@ -235,6 +248,7 @@
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"NodeQuotaForClusterExceededFault"},
{"shape":"NodeQuotaForCustomerExceededFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -252,6 +266,7 @@
{"shape":"ClusterNotFoundFault"},
{"shape":"InvalidARNFault"},
{"shape":"InvalidClusterStateFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -269,6 +284,7 @@
{"shape":"ClusterNotFoundFault"},
{"shape":"NodeNotFoundFault"},
{"shape":"InvalidClusterStateFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -287,6 +303,7 @@
{"shape":"TagQuotaPerResourceExceeded"},
{"shape":"InvalidARNFault"},
{"shape":"InvalidClusterStateFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -305,6 +322,7 @@
{"shape":"InvalidARNFault"},
{"shape":"TagNotFoundFault"},
{"shape":"InvalidClusterStateFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -323,6 +341,7 @@
{"shape":"ClusterNotFoundFault"},
{"shape":"InvalidParameterGroupStateFault"},
{"shape":"ParameterGroupNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -339,6 +358,7 @@
"errors":[
{"shape":"InvalidParameterGroupStateFault"},
{"shape":"ParameterGroupNotFoundFault"},
{"shape":"ServiceLinkedRoleNotFoundFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -356,7 +376,8 @@
{"shape":"SubnetGroupNotFoundFault"},
{"shape":"SubnetQuotaExceededFault"},
{"shape":"SubnetInUse"},
{"shape":"InvalidSubnet"}
{"shape":"InvalidSubnet"},
{"shape":"ServiceLinkedRoleNotFoundFault"}
],
"documentation":"<p>Modifies an existing subnet group.</p>"
}
@ -440,6 +461,10 @@
"ParameterGroup":{
"shape":"ParameterGroupStatus",
"documentation":"<p>The parameter group being used by nodes in the cluster.</p>"
},
"SSEDescription":{
"shape":"SSEDescription",
"documentation":"<p>The description of the server-side encryption status on the specified DAX cluster.</p>"
}
},
"documentation":"<p>Contains all of the attributes of a specific DAX cluster.</p>"
@ -478,8 +503,7 @@
"required":[
"ClusterName",
"NodeType",
"ReplicationFactor",
"IamRoleArn"
"ReplicationFactor"
],
"members":{
"ClusterName":{
@ -529,6 +553,10 @@
"Tags":{
"shape":"TagList",
"documentation":"<p>A set of tags to associate with the DAX cluster. </p>"
},
"SSESpecification":{
"shape":"SSESpecification",
"documentation":"<p>Represents the settings used to enable server-side encryption on the cluster.</p>"
}
}
},
@ -981,7 +1009,8 @@
"message":{"shape":"AwsQueryErrorMessage"}
},
"documentation":"<p>Two or more incompatible parameters were specified.</p>",
"exception":true
"exception":true,
"synthetic":true
},
"InvalidParameterGroupStateFault":{
"type":"structure",
@ -996,7 +1025,8 @@
"message":{"shape":"AwsQueryErrorMessage"}
},
"documentation":"<p>The value for a parameter is invalid.</p>",
"exception":true
"exception":true,
"synthetic":true
},
"InvalidSubnet":{
"type":"structure",
@ -1304,6 +1334,37 @@
}
}
},
"SSEDescription":{
"type":"structure",
"members":{
"Status":{
"shape":"SSEStatus",
"documentation":"<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul>"
}
},
"documentation":"<p>The description of the server-side encryption status on the specified DAX cluster.</p>"
},
"SSEEnabled":{"type":"boolean"},
"SSESpecification":{
"type":"structure",
"required":["Enabled"],
"members":{
"Enabled":{
"shape":"SSEEnabled",
"documentation":"<p>Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.</p>"
}
},
"documentation":"<p>Represents the settings used to enable server-side encryption.</p>"
},
"SSEStatus":{
"type":"string",
"enum":[
"ENABLING",
"ENABLED",
"DISABLING",
"DISABLED"
]
},
"SecurityGroupIdentifierList":{
"type":"list",
"member":{"shape":"String"}
@ -1326,6 +1387,12 @@
"type":"list",
"member":{"shape":"SecurityGroupMembership"}
},
"ServiceLinkedRoleNotFoundFault":{
"type":"structure",
"members":{
},
"exception":true
},
"SourceType":{
"type":"string",
"enum":[

135
botocore/data/devicefarm/2015-06-23/service-2.json
View file

@ -879,6 +879,22 @@
],
"documentation":"<p>Schedules a run.</p>"
},
"StopJob":{
"name":"StopJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopJobRequest"},
"output":{"shape":"StopJobResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.</p>"
},
"StopRemoteAccessSession":{
"name":"StopRemoteAccessSession",
"http":{
@ -991,6 +1007,22 @@
],
"documentation":"<p>Modifies the specified project name, given the project ARN and a new name.</p>"
},
"UpdateUpload":{
"name":"UpdateUpload",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateUploadRequest"},
"output":{"shape":"UpdateUploadResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
],
"documentation":"<p>Update an uploaded test specification (test spec).</p>"
},
"UpdateVPCEConfiguration":{
"name":"UpdateVPCEConfiguration",
"http":{
@ -1140,7 +1172,8 @@
"XCTEST_LOG",
"VIDEO",
"CUSTOMER_ARTIFACT",
"CUSTOMER_ARTIFACT_LOG"
"CUSTOMER_ARTIFACT_LOG",
"TESTSPEC_OUTPUT"
]
},
"Artifacts":{
@ -1480,7 +1513,7 @@
},
"type":{
"shape":"UploadType",
"documentation":"<p>The upload's upload type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> </ul> <p> <b>Note</b> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error.</p>"
"documentation":"<p>The upload's upload type.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web application upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> </ul> <p> <b>Note</b> If you call <code>CreateUpload</code> with <code>WEB_APP</code> specified, AWS Device Farm throws an <code>ArgumentException</code> error.</p>"
},
"contentType":{
"shape":"ContentType",
@ -1937,6 +1970,10 @@
"shape":"AppPackagesCleanup",
"documentation":"<p>True if app package cleanup is enabled at the beginning of the test; otherwise, false.</p>"
},
"videoCapture":{
"shape":"VideoCapture",
"documentation":"<p>Set to true to enable video capture; otherwise, set to false. The default is true.</p>"
},
"skipAppResign":{
"shape":"SkipAppResign",
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
@ -2517,6 +2554,14 @@
"deviceMinutes":{
"shape":"DeviceMinutes",
"documentation":"<p>Represents the total (metered or unmetered) minutes used by the job.</p>"
},
"videoEndpoint":{
"shape":"String",
"documentation":"<p>The endpoint for streaming device video.</p>"
},
"videoCapture":{
"shape":"VideoCapture",
"documentation":"<p>This value is set to true if video capture is enabled; otherwise, it is set to false.</p>"
}
},
"documentation":"<p>Represents a device.</p>"
@ -3026,6 +3071,10 @@
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the project for which you want to list uploads.</p>"
},
"type":{
"shape":"UploadType",
"documentation":"<p>The type of upload.</p> <p>Must be one of the following values:</p> <ul> <li> <p>ANDROID_APP: An Android upload.</p> </li> <li> <p>IOS_APP: An iOS upload.</p> </li> <li> <p>WEB_APP: A web appliction upload.</p> </li> <li> <p>EXTERNAL_DATA: An external data upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.</p> </li> <li> <p>CALABASH_TEST_PACKAGE: A Calabash test package upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.</p> </li> <li> <p>UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.</p> </li> <li> <p>UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.</p> </li> <li> <p>XCTEST_TEST_PACKAGE: An XCode test package upload.</p> </li> <li> <p>XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.</p> </li> <li> <p>APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.</p> </li> <li> <p>APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.</p> </li> <li> <p>INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.</p> </li> <li> <p>XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.</p> </li> </ul>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
@ -3790,6 +3839,10 @@
"skipAppResign":{
"shape":"SkipAppResign",
"documentation":"<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
},
"testSpecArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the YAML-formatted test specification for the run.</p>"
}
},
"documentation":"<p>Represents a test run on a set of devices with a given app package, test parameters, etc.</p>"
@ -3945,6 +3998,10 @@
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the uploaded test that will be run.</p>"
},
"testSpecArn":{
"shape":"AmazonResourceName",
"documentation":"<p>The ARN of the YAML-formatted test specification.</p>"
},
"filter":{
"shape":"Filter",
"documentation":"<p>The test's filter.</p>"
@ -3978,6 +4035,25 @@
"max":8192,
"min":0
},
"StopJobRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.</p>"
}
}
},
"StopJobResult":{
"type":"structure",
"members":{
"job":{
"shape":"Job",
"documentation":"<p>The job that was stopped.</p>"
}
}
},
"StopRemoteAccessSessionRequest":{
"type":"structure",
"required":["arn"],
@ -4393,6 +4469,37 @@
},
"documentation":"<p>Represents the result of an update project request.</p>"
},
"UpdateUploadRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"AmazonResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the uploaded test spec.</p>"
},
"name":{
"shape":"Name",
"documentation":"<p>The upload's test spec file name. The name should not contain the '/' character. The test spec file name must end with the <code>.yaml</code> or <code>.yml</code> file extension.</p>"
},
"contentType":{
"shape":"ContentType",
"documentation":"<p>The upload's content type (for example, \"application/x-yaml\").</p>"
},
"editContent":{
"shape":"Boolean",
"documentation":"<p>Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.</p>"
}
}
},
"UpdateUploadResult":{
"type":"structure",
"members":{
"upload":{
"shape":"Upload",
"documentation":"<p>A test spec uploaded to Device Farm.</p>"
}
}
},
"UpdateVPCEConfigurationRequest":{
"type":"structure",
"required":["arn"],
@ -4466,10 +4573,21 @@
"message":{
"shape":"Message",
"documentation":"<p>A message about the upload's result.</p>"
},
"category":{
"shape":"UploadCategory",
"documentation":"<p>The upload's category. Allowed values include:</p> <ul> <li> <p>CURATED: An upload managed by AWS Device Farm.</p> </li> <li> <p>PRIVATE: An upload managed by the AWS Device Farm customer.</p> </li> </ul>"
}
},
"documentation":"<p>An app or a set of one or more tests to upload or that have been uploaded.</p>"
},
"UploadCategory":{
"type":"string",
"enum":[
"CURATED",
"PRIVATE"
]
},
"UploadStatus":{
"type":"string",
"enum":[
@ -4497,7 +4615,15 @@
"UIAUTOMATION_TEST_PACKAGE",
"UIAUTOMATOR_TEST_PACKAGE",
"XCTEST_TEST_PACKAGE",
"XCTEST_UI_TEST_PACKAGE"
"XCTEST_UI_TEST_PACKAGE",
"APPIUM_JAVA_JUNIT_TEST_SPEC",
"APPIUM_JAVA_TESTNG_TEST_SPEC",
"APPIUM_PYTHON_TEST_SPEC",
"APPIUM_WEB_JAVA_JUNIT_TEST_SPEC",
"APPIUM_WEB_JAVA_TESTNG_TEST_SPEC",
"APPIUM_WEB_PYTHON_TEST_SPEC",
"INSTRUMENTATION_TEST_SPEC",
"XCTEST_UI_TEST_SPEC"
]
},
"Uploads":{
@ -4548,7 +4674,8 @@
"type":"string",
"max":2048,
"min":0
}
},
"VideoCapture":{"type":"boolean"}
},
"documentation":"<p>AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.</p>"
}

38
botocore/data/directconnect/2012-10-25/service-2.json
View file

@ -818,8 +818,10 @@
},
"AwsDevice":{
"type":"string",
"documentation":"<p>An abstract ID for the physical Direct Connect endpoint.</p> <p>Example: EQC50-abcdef123456</p>"
"documentation":"<p>An abstract ID for the physical Direct Connect endpoint.</p> <p>Example: EQC50-abcdef123456</p>",
"deprecated":true
},
"AwsDeviceV2":{"type":"string"},
"BGPAuthKey":{
"type":"string",
"documentation":"<p>The authentication key for BGP configuration.</p> <p>Example: asdf34example</p>"
@ -833,7 +835,11 @@
"amazonAddress":{"shape":"AmazonAddress"},
"customerAddress":{"shape":"CustomerAddress"},
"bgpPeerState":{"shape":"BGPPeerState"},
"bgpStatus":{"shape":"BGPStatus"}
"bgpStatus":{"shape":"BGPStatus"},
"awsDeviceV2":{
"shape":"AwsDeviceV2",
"documentation":"<p>The Direct Connection endpoint which the BGP peer terminates on.</p>"
}
},
"documentation":"<p>A structure containing information about a BGP peer.</p>"
},
@ -855,7 +861,7 @@
},
"BGPStatus":{
"type":"string",
"documentation":"<p>The Up/Down state of the BGP peer.</p> <ul> <li> <p> <b>Up</b>: The BGP peer is established.</p> </li> <li> <p> <b>Down</b>: The BGP peer is down.</p> </li> </ul>",
"documentation":"<p>The Up/Down state of the BGP peer.</p> <ul> <li> <p> <b>Up</b>: The BGP peer is established.</p> <note> <p>A state of <code>up</code> does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.</p> </note> </li> <li> <p> <b>Down</b>: The BGP peer is down.</p> </li> </ul>",
"enum":[
"up",
"down"
@ -948,6 +954,10 @@
"lagId":{"shape":"LagId"},
"awsDevice":{
"shape":"AwsDevice",
"documentation":"<p>Deprecated in favor of awsDeviceV2.</p> <p>The Direct Connection endpoint which the physical connection terminates on.</p>"
},
"awsDeviceV2":{
"shape":"AwsDeviceV2",
"documentation":"<p>The Direct Connection endpoint which the physical connection terminates on.</p>"
}
},
@ -1681,6 +1691,10 @@
"lagId":{"shape":"LagId"},
"awsDevice":{
"shape":"AwsDevice",
"documentation":"<p>Deprecated in favor of awsDeviceV2.</p> <p>The Direct Connection endpoint which the physical connection terminates on.</p>"
},
"awsDeviceV2":{
"shape":"AwsDeviceV2",
"documentation":"<p>The Direct Connection endpoint which the physical connection terminates on.</p>"
}
},
@ -1750,6 +1764,10 @@
},
"awsDevice":{
"shape":"AwsDevice",
"documentation":"<p>Deprecated in favor of awsDeviceV2.</p> <p>The AWS Direct Connection endpoint that hosts the LAG.</p>"
},
"awsDeviceV2":{
"shape":"AwsDeviceV2",
"documentation":"<p>The AWS Direct Connection endpoint that hosts the LAG.</p>"
},
"connections":{
@ -1823,6 +1841,10 @@
"locationName":{
"shape":"LocationName",
"documentation":"<p>The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.</p>"
},
"region":{
"shape":"Region",
"documentation":"<p>The AWS region where the AWS Direct connect location is located.</p> <p>Example: us-east-1</p> <p>Default: None</p>"
}
},
"documentation":"<p>An AWS Direct Connect location where connections and interconnects can be requested.</p>"
@ -2172,7 +2194,15 @@
"virtualGatewayId":{"shape":"VirtualGatewayId"},
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"routeFilterPrefixes":{"shape":"RouteFilterPrefixList"},
"bgpPeers":{"shape":"BGPPeerList"}
"bgpPeers":{"shape":"BGPPeerList"},
"region":{
"shape":"Region",
"documentation":"<p>The AWS region where the virtual interface is located.</p> <p>Example: us-east-1</p> <p>Default: None</p>"
},
"awsDeviceV2":{
"shape":"AwsDeviceV2",
"documentation":"<p>The Direct Connection endpoint which the virtual interface terminates on.</p>"
}
},
"documentation":"<p>A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.</p>"
},

3
botocore/data/dlm/2018-01-12/paginators-1.json Normal file
View file

@ -0,0 +1,3 @@
{
"pagination": {}
}

558
botocore/data/dlm/2018-01-12/service-2.json Normal file
View file

@ -0,0 +1,558 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-01-12",
"endpointPrefix":"dlm",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceAbbreviation":"Amazon DLM",
"serviceFullName":"Amazon Data Lifecycle Manager",
"serviceId":"DLM",
"signatureVersion":"v4",
"signingName":"dlm",
"uid":"dlm-2018-01-12"
},
"operations":{
"CreateLifecyclePolicy":{
"name":"CreateLifecyclePolicy",
"http":{
"method":"POST",
"requestUri":"/policies"
},
"input":{"shape":"CreateLifecyclePolicyRequest"},
"output":{"shape":"CreateLifecyclePolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.</p>"
},
"DeleteLifecyclePolicy":{
"name":"DeleteLifecyclePolicy",
"http":{
"method":"DELETE",
"requestUri":"/policies/{policyId}/"
},
"input":{"shape":"DeleteLifecyclePolicyRequest"},
"output":{"shape":"DeleteLifecyclePolicyResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Deletes the specified lifecycle policy and halts the automated operations that the policy specified.</p>"
},
"GetLifecyclePolicies":{
"name":"GetLifecyclePolicies",
"http":{
"method":"GET",
"requestUri":"/policies"
},
"input":{"shape":"GetLifecyclePoliciesRequest"},
"output":{"shape":"GetLifecyclePoliciesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServerException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Gets summary information about all or the specified data lifecycle policies.</p> <p>To get complete information about a policy, use <a>GetLifecyclePolicy</a>.</p>"
},
"GetLifecyclePolicy":{
"name":"GetLifecyclePolicy",
"http":{
"method":"GET",
"requestUri":"/policies/{policyId}/"
},
"input":{"shape":"GetLifecyclePolicyRequest"},
"output":{"shape":"GetLifecyclePolicyResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Gets detailed information about the specified lifecycle policy.</p>"
},
"UpdateLifecyclePolicy":{
"name":"UpdateLifecyclePolicy",
"http":{
"method":"PATCH",
"requestUri":"/policies/{policyId}"
},
"input":{"shape":"UpdateLifecyclePolicyRequest"},
"output":{"shape":"UpdateLifecyclePolicyResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServerException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Updates the specified lifecycle policy.</p>"
}
},
"shapes":{
"Count":{
"type":"integer",
"max":1000,
"min":1
},
"CreateLifecyclePolicyRequest":{
"type":"structure",
"required":[
"ExecutionRoleArn",
"Description",
"State",
"PolicyDetails"
],
"members":{
"ExecutionRoleArn":{
"shape":"ExecutionRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>"
},
"Description":{
"shape":"PolicyDescription",
"documentation":"<p>A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.</p>"
},
"State":{
"shape":"SettablePolicyStateValues",
"documentation":"<p>The desired activation state of the lifecycle policy after creation.</p>"
},
"PolicyDetails":{
"shape":"PolicyDetails",
"documentation":"<p>The configuration of the lifecycle policy.</p> <p>Target tags cannot be re-used across lifecycle policies.</p>"
}
}
},
"CreateLifecyclePolicyResponse":{
"type":"structure",
"members":{
"PolicyId":{
"shape":"PolicyId",
"documentation":"<p>The identifier of the lifecycle policy.</p>"
}
}
},
"CreateRule":{
"type":"structure",
"required":[
"Interval",
"IntervalUnit"
],
"members":{
"Interval":{
"shape":"Interval",
"documentation":"<p>The interval. The supported values are 12 and 24.</p>"
},
"IntervalUnit":{
"shape":"IntervalUnitValues",
"documentation":"<p>The interval unit.</p>"
},
"Times":{
"shape":"TimesList",
"documentation":"<p>The time, in UTC, to start the operation.</p> <p>The operation occurs within a one-hour window following the specified time.</p>"
}
},
"documentation":"<p>Specifies when to create snapshots of EBS volumes.</p>"
},
"DeleteLifecyclePolicyRequest":{
"type":"structure",
"required":["PolicyId"],
"members":{
"PolicyId":{
"shape":"PolicyId",
"documentation":"<p>The identifier of the lifecycle policy.</p>",
"location":"uri",
"locationName":"policyId"
}
}
},
"DeleteLifecyclePolicyResponse":{
"type":"structure",
"members":{
}
},
"ErrorCode":{"type":"string"},
"ErrorMessage":{"type":"string"},
"ExecutionRoleArn":{"type":"string"},
"GetLifecyclePoliciesRequest":{
"type":"structure",
"members":{
"PolicyIds":{
"shape":"PolicyIdList",
"documentation":"<p>The identifiers of the data lifecycle policies.</p>",
"location":"querystring",
"locationName":"policyIds"
},
"State":{
"shape":"GettablePolicyStateValues",
"documentation":"<p>The activation state.</p>",
"location":"querystring",
"locationName":"state"
},
"ResourceTypes":{
"shape":"ResourceTypeValuesList",
"documentation":"<p>The resource type.</p>",
"location":"querystring",
"locationName":"resourceTypes"
},
"TargetTags":{
"shape":"TargetTagsFilterList",
"documentation":"<p>The target tags.</p> <p>Tags are strings in the format <code>key:value</code>.</p>",
"location":"querystring",
"locationName":"targetTags"
},
"TagsToAdd":{
"shape":"TagsToAddFilterList",
"documentation":"<p>The tags to add to the resources.</p> <p>Tags are strings in the format <code>key:value</code>.</p> <p>These tags are added in addition to the AWS-added lifecycle tags.</p>",
"location":"querystring",
"locationName":"tagsToAdd"
}
}
},
"GetLifecyclePoliciesResponse":{
"type":"structure",
"members":{
"Policies":{
"shape":"LifecyclePolicySummaryList",
"documentation":"<p>Summary information about the lifecycle policies.</p>"
}
}
},
"GetLifecyclePolicyRequest":{
"type":"structure",
"required":["PolicyId"],
"members":{
"PolicyId":{
"shape":"PolicyId",
"documentation":"<p>The identifier of the lifecycle policy.</p>",
"location":"uri",
"locationName":"policyId"
}
}
},
"GetLifecyclePolicyResponse":{
"type":"structure",
"members":{
"Policy":{
"shape":"LifecyclePolicy",
"documentation":"<p>Detailed information about the lifecycle policy.</p>"
}
}
},
"GettablePolicyStateValues":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED",
"ERROR"
]
},
"InternalServerException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Code":{"shape":"ErrorCode"}
},
"documentation":"<p>The service failed in an unexpected way.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"Interval":{
"type":"integer",
"min":1
},
"IntervalUnitValues":{
"type":"string",
"enum":["HOURS"]
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Code":{"shape":"ErrorCode"},
"RequiredParameters":{
"shape":"ParameterList",
"documentation":"<p>The request omitted one or more required parameters.</p>"
},
"MutuallyExclusiveParameters":{
"shape":"ParameterList",
"documentation":"<p>The request included parameters that cannot be provided together.</p>"
}
},
"documentation":"<p>Bad request. The request is missing required parameters or has invalid parameters.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LifecyclePolicy":{
"type":"structure",
"members":{
"PolicyId":{
"shape":"PolicyId",
"documentation":"<p>The identifier of the lifecycle policy.</p>"
},
"Description":{
"shape":"PolicyDescription",
"documentation":"<p>The description of the lifecycle policy.</p>"
},
"State":{
"shape":"GettablePolicyStateValues",
"documentation":"<p>The activation state of the lifecycle policy.</p>"
},
"ExecutionRoleArn":{
"shape":"ExecutionRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>"
},
"DateCreated":{
"shape":"Timestamp",
"documentation":"<p>The local date and time when the lifecycle policy was created.</p>"
},
"DateModified":{
"shape":"Timestamp",
"documentation":"<p>The local date and time when the lifecycle policy was last modified.</p>"
},
"PolicyDetails":{
"shape":"PolicyDetails",
"documentation":"<p>The configuration of the lifecycle policy</p>"
}
},
"documentation":"<p>Detailed information about a lifecycle policy.</p>"
},
"LifecyclePolicySummary":{
"type":"structure",
"members":{
"PolicyId":{
"shape":"PolicyId",
"documentation":"<p>The identifier of the lifecycle policy.</p>"
},
"Description":{
"shape":"PolicyDescription",
"documentation":"<p>The description of the lifecycle policy.</p>"
},
"State":{
"shape":"GettablePolicyStateValues",
"documentation":"<p>The activation state of the lifecycle policy.</p>"
}
},
"documentation":"<p>Summary information about a lifecycle policy.</p>"
},
"LifecyclePolicySummaryList":{
"type":"list",
"member":{"shape":"LifecyclePolicySummary"}
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Code":{"shape":"ErrorCode"},
"ResourceType":{
"shape":"String",
"documentation":"<p>Value is the type of resource for which a limit was exceeded.</p>"
}
},
"documentation":"<p>The request failed because a limit was exceeded.</p>",
"error":{"httpStatusCode":429},
"exception":true
},
"Parameter":{"type":"string"},
"ParameterList":{
"type":"list",
"member":{"shape":"Parameter"}
},
"PolicyDescription":{
"type":"string",
"max":500,
"min":0
},
"PolicyDetails":{
"type":"structure",
"members":{
"ResourceTypes":{
"shape":"ResourceTypeValuesList",
"documentation":"<p>The resource type.</p>"
},
"TargetTags":{
"shape":"TargetTagList",
"documentation":"<p>The target tags.</p>"
},
"Schedules":{
"shape":"ScheduleList",
"documentation":"<p>The schedule.</p>"
}
},
"documentation":"<p>Specifies the configuration of a lifecycle policy.</p>"
},
"PolicyId":{"type":"string"},
"PolicyIdList":{
"type":"list",
"member":{"shape":"PolicyId"}
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Code":{"shape":"ErrorCode"},
"ResourceType":{
"shape":"String",
"documentation":"<p>Value is the type of resource that was not found.</p>"
},
"ResourceIds":{
"shape":"PolicyIdList",
"documentation":"<p>Value is a list of resource IDs that were not found.</p>"
}
},
"documentation":"<p>A requested resource was not found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"ResourceTypeValues":{
"type":"string",
"enum":["VOLUME"]
},
"ResourceTypeValuesList":{
"type":"list",
"member":{"shape":"ResourceTypeValues"},
"max":1,
"min":1
},
"RetainRule":{
"type":"structure",
"required":["Count"],
"members":{
"Count":{
"shape":"Count",
"documentation":"<p>The number of snapshots to keep for each volume, up to a maximum of 1000.</p>"
}
},
"documentation":"<p>Specifies the number of snapshots to keep for each EBS volume.</p>"
},
"Schedule":{
"type":"structure",
"members":{
"Name":{
"shape":"ScheduleName",
"documentation":"<p>The name of the schedule.</p>"
},
"TagsToAdd":{
"shape":"TagsToAddList",
"documentation":"<p>The tags to add to policy-created resources. These tags are added in addition to the default lifecycle tags.</p>"
},
"CreateRule":{
"shape":"CreateRule",
"documentation":"<p>The create rule.</p>"
},
"RetainRule":{
"shape":"RetainRule",
"documentation":"<p>The retain rule.</p>"
}
},
"documentation":"<p>Specifies a schedule.</p>"
},
"ScheduleList":{
"type":"list",
"member":{"shape":"Schedule"},
"max":1,
"min":1
},
"ScheduleName":{
"type":"string",
"max":500,
"min":0
},
"SettablePolicyStateValues":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"String":{"type":"string"},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"String",
"documentation":"<p>The tag key.</p>"
},
"Value":{
"shape":"String",
"documentation":"<p>The tag value.</p>"
}
},
"documentation":"<p>Specifies a tag for a resource.</p>"
},
"TagFilter":{"type":"string"},
"TagsToAddFilterList":{
"type":"list",
"member":{"shape":"TagFilter"},
"max":50,
"min":0
},
"TagsToAddList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":0
},
"TargetTagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TargetTagsFilterList":{
"type":"list",
"member":{"shape":"TagFilter"},
"max":50,
"min":1
},
"Time":{
"type":"string",
"pattern":"^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"
},
"TimesList":{
"type":"list",
"member":{"shape":"Time"},
"max":1
},
"Timestamp":{"type":"timestamp"},
"UpdateLifecyclePolicyRequest":{
"type":"structure",
"required":["PolicyId"],
"members":{
"PolicyId":{
"shape":"PolicyId",
"documentation":"<p>The identifier of the lifecycle policy.</p>",
"location":"uri",
"locationName":"policyId"
},
"ExecutionRoleArn":{
"shape":"ExecutionRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>"
},
"State":{
"shape":"SettablePolicyStateValues",
"documentation":"<p>The desired activation state of the lifecycle policy after creation.</p>"
},
"Description":{
"shape":"PolicyDescription",
"documentation":"<p>A description of the lifecycle policy.</p>"
},
"PolicyDetails":{
"shape":"PolicyDetails",
"documentation":"<p>The configuration of the lifecycle policy.</p> <p>Target tags cannot be re-used across policies.</p>"
}
}
},
"UpdateLifecyclePolicyResponse":{
"type":"structure",
"members":{
}
}
},
"documentation":"<fullname>Amazon Data Lifecycle Manager</fullname> <p>With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.</p> <p>Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-lifecycle.html\">Automating the Amazon EBS Snapshot Lifecycle</a> in the <i>Amazon EC2 User Guide</i>.</p>"
}

213
botocore/data/dynamodb/2012-08-10/service-2.json
View file

@ -635,6 +635,149 @@
},
"documentation":"<p>For the <code>UpdateItem</code> operation, represents the attributes to be modified, the action to perform on each, and the new value for each.</p> <note> <p>You cannot use <code>UpdateItem</code> to update any primary key attributes. Instead, you will need to delete the item, and then use <code>PutItem</code> to create a new item with new attributes.</p> </note> <p>Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a <code>ValidationException</code> exception.</p>"
},
"AutoScalingPolicyDescription":{
"type":"structure",
"members":{
"PolicyName":{
"shape":"AutoScalingPolicyName",
"documentation":"<p>The name of the scaling policy.</p>"
},
"TargetTrackingScalingPolicyConfiguration":{
"shape":"AutoScalingTargetTrackingScalingPolicyConfigurationDescription",
"documentation":"<p>Represents a target tracking scaling policy configuration.</p>"
}
},
"documentation":"<p>Represents the properties of the scaling policy.</p>"
},
"AutoScalingPolicyDescriptionList":{
"type":"list",
"member":{"shape":"AutoScalingPolicyDescription"}
},
"AutoScalingPolicyName":{
"type":"string",
"max":256,
"min":1,
"pattern":"\\p{Print}+"
},
"AutoScalingPolicyUpdate":{
"type":"structure",
"required":["TargetTrackingScalingPolicyConfiguration"],
"members":{
"PolicyName":{
"shape":"AutoScalingPolicyName",
"documentation":"<p>The name of the scaling policy.</p>"
},
"TargetTrackingScalingPolicyConfiguration":{
"shape":"AutoScalingTargetTrackingScalingPolicyConfigurationUpdate",
"documentation":"<p>Represents a target tracking scaling policy configuration.</p>"
}
},
"documentation":"<p>Represents the autoscaling policy to be modified.</p>"
},
"AutoScalingRoleArn":{
"type":"string",
"max":1600,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"AutoScalingSettingsDescription":{
"type":"structure",
"members":{
"MinimumUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The minimum capacity units that a global table or global secondary index should be scaled down to.</p>"
},
"MaximumUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The maximum capacity units that a global table or global secondary index should be scaled up to.</p>"
},
"AutoScalingDisabled":{
"shape":"BooleanObject",
"documentation":"<p>Disabled autoscaling for this global table or global secondary index.</p>"
},
"AutoScalingRoleArn":{
"shape":"String",
"documentation":"<p>Role ARN used for configuring autoScaling policy.</p>"
},
"ScalingPolicies":{
"shape":"AutoScalingPolicyDescriptionList",
"documentation":"<p>Information about the scaling policies.</p>"
}
},
"documentation":"<p>Represents the autoscaling settings for a global table or global secondary index.</p>"
},
"AutoScalingSettingsUpdate":{
"type":"structure",
"members":{
"MinimumUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The minimum capacity units that a global table or global secondary index should be scaled down to.</p>"
},
"MaximumUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The maximum capacity units that a global table or global secondary index should be scaled up to.</p>"
},
"AutoScalingDisabled":{
"shape":"BooleanObject",
"documentation":"<p>Disabled autoscaling for this global table or global secondary index.</p>"
},
"AutoScalingRoleArn":{
"shape":"AutoScalingRoleArn",
"documentation":"<p>Role ARN used for configuring autoscaling policy.</p>"
},
"ScalingPolicyUpdate":{
"shape":"AutoScalingPolicyUpdate",
"documentation":"<p>The scaling policy to apply for scaling target global table or global secondary index capacity units.</p>"
}
},
"documentation":"<p>Represents the autoscaling settings to be modified for a global table or global secondary index.</p>"
},
"AutoScalingTargetTrackingScalingPolicyConfigurationDescription":{
"type":"structure",
"required":["TargetValue"],
"members":{
"DisableScaleIn":{
"shape":"BooleanObject",
"documentation":"<p>Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.</p>"
},
"ScaleInCooldown":{
"shape":"IntegerObject",
"documentation":"<p>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. You should 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 autoscaling scales out your scalable target immediately. </p>"
},
"ScaleOutCooldown":{
"shape":"IntegerObject",
"documentation":"<p>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. You should continuously (but not excessively) scale out.</p>"
},
"TargetValue":{
"shape":"Double",
"documentation":"<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).</p>"
}
},
"documentation":"<p>Represents the properties of a target tracking scaling policy.</p>"
},
"AutoScalingTargetTrackingScalingPolicyConfigurationUpdate":{
"type":"structure",
"required":["TargetValue"],
"members":{
"DisableScaleIn":{
"shape":"BooleanObject",
"documentation":"<p>Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.</p>"
},
"ScaleInCooldown":{
"shape":"IntegerObject",
"documentation":"<p>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. You should 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 autoscaling scales out your scalable target immediately. </p>"
},
"ScaleOutCooldown":{
"shape":"IntegerObject",
"documentation":"<p>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. You should continuously (but not excessively) scale out.</p>"
},
"TargetValue":{
"shape":"Double",
"documentation":"<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).</p>"
}
},
"documentation":"<p>Represents the settings of a target tracking scaling policy that will be modified.</p>"
},
"Backfilling":{"type":"boolean"},
"BackupArn":{
"type":"string",
@ -666,6 +809,7 @@
"BackupArn",
"BackupName",
"BackupStatus",
"BackupType",
"BackupCreationDateTime"
],
"members":{
@ -685,9 +829,17 @@
"shape":"BackupStatus",
"documentation":"<p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED. </p>"
},
"BackupType":{
"shape":"BackupType",
"documentation":"<p>BackupType:</p> <ul> <li> <p> <code>USER</code> - On demand backup created by you.</p> </li> <li> <p> <code>SYSTEM</code> - On demand backup automatically created by DynamoDB.</p> </li> </ul>"
},
"BackupCreationDateTime":{
"shape":"BackupCreationDateTime",
"documentation":"<p>Time at which the backup was created. This is the request time of the backup. </p>"
},
"BackupExpiryDateTime":{
"shape":"Date",
"documentation":"<p>Time at which the automatic on demand backup created by DynamoDB will expire. This <code>SYSTEM</code> on demand backup expires automatically 35 days after its creation.</p>"
}
},
"documentation":"<p>Contains the details of the backup created for the table.</p>"
@ -757,10 +909,18 @@
"shape":"BackupCreationDateTime",
"documentation":"<p>Time at which the backup was created.</p>"
},
"BackupExpiryDateTime":{
"shape":"Date",
"documentation":"<p>Time at which the automatic on demand backup created by DynamoDB will expire. This <code>SYSTEM</code> on demand backup expires automatically 35 days after its creation.</p>"
},
"BackupStatus":{
"shape":"BackupStatus",
"documentation":"<p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED.</p>"
},
"BackupType":{
"shape":"BackupType",
"documentation":"<p>BackupType:</p> <ul> <li> <p> <code>USER</code> - On demand backup created by you.</p> </li> <li> <p> <code>SYSTEM</code> - On demand backup automatically created by DynamoDB.</p> </li> </ul>"
},
"BackupSizeBytes":{
"shape":"BackupSizeBytes",
"documentation":"<p>Size of the backup in bytes.</p>"
@ -768,6 +928,21 @@
},
"documentation":"<p>Contains details for the backup.</p>"
},
"BackupType":{
"type":"string",
"enum":[
"USER",
"SYSTEM"
]
},
"BackupTypeFilter":{
"type":"string",
"enum":[
"USER",
"SYSTEM",
"ALL"
]
},
"BackupsInputLimit":{
"type":"integer",
"max":100,
@ -1419,6 +1594,7 @@
}
}
},
"Double":{"type":"double"},
"ErrorMessage":{"type":"string"},
"ExpectedAttributeMap":{
"type":"map",
@ -1699,6 +1875,10 @@
"ProvisionedWriteCapacityUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException.</code> </p>"
},
"ProvisionedWriteCapacityAutoScalingSettingsUpdate":{
"shape":"AutoScalingSettingsUpdate",
"documentation":"<p>AutoScaling settings for managing a global secondary index's write capacity units.</p>"
}
},
"documentation":"<p>Represents the settings of a global secondary index for a global table that will be modified.</p>"
@ -1754,6 +1934,7 @@
]
},
"Integer":{"type":"integer"},
"IntegerObject":{"type":"integer"},
"InternalServerError":{
"type":"structure",
"members":{
@ -1944,6 +2125,10 @@
"ExclusiveStartBackupArn":{
"shape":"BackupArn",
"documentation":"<p> <code>LastEvaluatedBackupArn</code> is the ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the <code>ExclusiveStartBackupArn</code> of a new <code>ListBackups</code> operation in order to fetch the next page of results. </p>"
},
"BackupType":{
"shape":"BackupTypeFilter",
"documentation":"<p>The backups from the table specified by BackupType are listed.</p> <p>Where BackupType can be:</p> <ul> <li> <p> <code>USER</code> - On demand backup created by you.</p> </li> <li> <p> <code>SYSTEM</code> - On demand backup automatically created by DynamoDB.</p> </li> <li> <p> <code>ALL</code> - All types of on demand backups (USER and SYSTEM).</p> </li> </ul>"
}
}
},
@ -2515,9 +2700,17 @@
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>"
},
"ProvisionedReadCapacityAutoScalingSettings":{
"shape":"AutoScalingSettingsDescription",
"documentation":"<p>Autoscaling settings for a global secondary index replica's read capacity units.</p>"
},
"ProvisionedWriteCapacityUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>"
},
"ProvisionedWriteCapacityAutoScalingSettings":{
"shape":"AutoScalingSettingsDescription",
"documentation":"<p>AutoScaling settings for a global secondary index replica's write capacity units.</p>"
}
},
"documentation":"<p>Represents the properties of a global secondary index.</p>"
@ -2537,6 +2730,10 @@
"ProvisionedReadCapacityUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>"
},
"ProvisionedReadCapacityAutoScalingSettingsUpdate":{
"shape":"AutoScalingSettingsUpdate",
"documentation":"<p>Autoscaling settings for managing a global secondary index replica's read capacity units.</p>"
}
},
"documentation":"<p>Represents the settings of a global secondary index for a global table that will be modified.</p>"
@ -2575,10 +2772,18 @@
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>"
},
"ReplicaProvisionedReadCapacityAutoScalingSettings":{
"shape":"AutoScalingSettingsDescription",
"documentation":"<p>Autoscaling settings for a global table replica's read capacity units.</p>"
},
"ReplicaProvisionedWriteCapacityUnits":{
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
},
"ReplicaProvisionedWriteCapacityAutoScalingSettings":{
"shape":"AutoScalingSettingsDescription",
"documentation":"<p>AutoScaling settings for a global table replica's write capacity units.</p>"
},
"ReplicaGlobalSecondaryIndexSettings":{
"shape":"ReplicaGlobalSecondaryIndexSettingsDescriptionList",
"documentation":"<p>Replica global secondary index settings for the global table.</p>"
@ -2602,6 +2807,10 @@
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>"
},
"ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate":{
"shape":"AutoScalingSettingsUpdate",
"documentation":"<p>Autoscaling settings for managing a global table replica's read capacity units.</p>"
},
"ReplicaGlobalSecondaryIndexSettingsUpdate":{
"shape":"ReplicaGlobalSecondaryIndexSettingsUpdateList",
"documentation":"<p>Represents the settings of a global secondary index for a global table that will be modified.</p>"
@ -3385,6 +3594,10 @@
"shape":"PositiveLongObject",
"documentation":"<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException.</code> </p>"
},
"GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate":{
"shape":"AutoScalingSettingsUpdate",
"documentation":"<p>AutoScaling settings for managing provisioned write capacity for the global table.</p>"
},
"GlobalTableGlobalSecondaryIndexSettingsUpdate":{
"shape":"GlobalTableGlobalSecondaryIndexSettingsUpdateList",
"documentation":"<p>Represents the settings of a global secondary index for a global table that will be modified.</p>"

426
botocore/data/ec2/2016-11-15/service-2.json
View file

File diff suppressed because one or more lines are too long

209
botocore/data/ecs/2014-11-13/service-2.json
View file

@ -97,7 +97,7 @@
{"shape":"ClusterNotFoundException"},
{"shape":"ServiceNotFoundException"}
],
"documentation":"<p>Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>.</p> <note> <p>When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations. However, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services return a <code>ServiceNotFoundException</code> error.</p> </note>"
"documentation":"<p>Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see <a>UpdateService</a>.</p> <note> <p>When you delete a service, if there are still running tasks that require cleanup, the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the service is no longer visible in the console or in <a>ListServices</a> API operations. After the tasks have stopped, then the service status moves from <code>DRAINING</code> to <code>INACTIVE</code>. Services in the <code>DRAINING</code> or <code>INACTIVE</code> status can still be viewed with <a>DescribeServices</a> API operations. However, in the future, <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record keeping, and <a>DescribeServices</a> API operations on those services return a <code>ServiceNotFoundException</code> error.</p> </note> <important> <p>If you attempt to create a new service with the same name as an existing service in either <code>ACTIVE</code> or <code>DRAINING</code> status, you will receive an error.</p> </important>"
},
"DeregisterContainerInstance":{
"name":"DeregisterContainerInstance",
@ -374,7 +374,7 @@
{"shape":"ClientException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify a Docker networking mode for the containers in your task definition with the <code>networkMode</code> parameter. The available network modes correspond to those described in <a href=\"https://docs.docker.com/engine/reference/run/#/network-settings\">Network settings</a> in the Docker run reference. If you specify the <code>awsvpc</code> network mode, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify a Docker networking mode for the containers in your task definition with the <code>networkMode</code> parameter. The available network modes correspond to those described in <a href=\"https://docs.docker.com/engine/reference/run/#/network-settings\">Network settings</a> in the Docker run reference. If you specify the <code>awsvpc</code> network mode, the task is allocated an elastic network interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"RunTask":{
"name":"RunTask",
@ -395,7 +395,7 @@
{"shape":"AccessDeniedException"},
{"shape":"BlockedException"}
],
"documentation":"<p>Starts a new task using the specified task definition.</p> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or place tasks manually on specific container instances.</p> <p>The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time, and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul>"
"documentation":"<p>Starts a new task using the specified task definition.</p> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or place tasks manually on specific container instances.</p> <p>The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul>"
},
"StartTask":{
"name":"StartTask",
@ -559,7 +559,7 @@
},
"details":{
"shape":"AttachmentDetails",
"documentation":"<p>Details of the attachment. For Elastic Network Interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.</p>"
"documentation":"<p>Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.</p>"
}
},
"documentation":"<p>An object representing a container instance or task attachment.</p>"
@ -634,15 +634,15 @@
"members":{
"subnets":{
"shape":"StringList",
"documentation":"<p>The subnets associated with the task or service. There is a limit of 10 subnets able to be specified per AwsVpcConfiguration.</p>"
"documentation":"<p>The subnets associated with the task or service. There is a limit of 10 subnets able to be specified per <code>AwsVpcConfiguration</code>.</p> <note> <p>All specified subnets must be from the same VPC.</p> </note>"
},
"securityGroups":{
"shape":"StringList",
"documentation":"<p>The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups able to be specified per AwsVpcConfiguration.</p>"
"documentation":"<p>The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups able to be specified per <code>AwsVpcConfiguration</code>.</p> <note> <p>All specified security groups must be from the same VPC.</p> </note>"
},
"assignPublicIp":{
"shape":"AssignPublicIp",
"documentation":"<p>Whether the task's elastic network interface receives a public IP address.</p>"
"documentation":"<p>Whether the task's elastic network interface receives a public IP address. The default value is <code>DISABLED</code>.</p>"
}
},
"documentation":"<p>An object representing the networking details for a task or service.</p>"
@ -676,7 +676,7 @@
"members":{
"clusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, <code>arn:aws:ecs:<i>region</i>:<i>012345678910</i>:cluster/<i>test</i> </code>..</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the <code>cluster</code> namespace, and then the cluster name. For example, <code>arn:aws:ecs:<i>region</i>:<i>012345678910</i>:cluster/<i>test</i> </code>..</p>"
},
"clusterName":{
"shape":"String",
@ -688,7 +688,7 @@
},
"registeredContainerInstancesCount":{
"shape":"Integer",
"documentation":"<p>The number of container instances registered into the cluster.</p>"
"documentation":"<p>The number of container instances registered into the cluster. This includes container instances in both <code>ACTIVE</code> and <code>DRAINING</code> status.</p>"
},
"runningTasksCount":{
"shape":"Integer",
@ -814,31 +814,35 @@
"members":{
"name":{
"shape":"String",
"documentation":"<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>"
"documentation":"<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>"
},
"image":{
"shape":"String",
"documentation":"<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.</p> </li> <li> <p>Images in Amazon ECR repositories can be specified by either using the full <code>registry/repository:tag</code> or <code>registry/repository@digest</code>. For example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;:latest</code> or <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</code>. </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
"documentation":"<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.</p> </li> <li> <p>Images in Amazon ECR repositories can be specified by either using the full <code>registry/repository:tag</code> or <code>registry/repository@digest</code>. For example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;:latest</code> or <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</code>. </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>"
},
"repositoryCredentials":{
"shape":"RepositoryCredentials",
"documentation":"<p>The private repository authentication credentials to use.</p>"
},
"cpu":{
"shape":"Integer",
"documentation":"<p>The number of <code>cpu</code> units reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level <code>cpu</code> value.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul> <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.</p>"
"documentation":"<p>The number of <code>cpu</code> units reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level <code>cpu</code> value.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul> <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.</p>"
},
"memory":{
"shape":"BoxedInteger",
"documentation":"<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task <code>memory</code> value.</p> <p>For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>"
"documentation":"<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task <code>memory</code> value.</p> <p>For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>"
},
"memoryReservation":{
"shape":"BoxedInteger",
"documentation":"<p>The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>"
"documentation":"<p>The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>"
},
"links":{
"shape":"StringList",
"documentation":"<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to <code>bridge</code>. The <code>name:internalName</code> construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to <a href=\"https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/\">https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/run/\"> <code>docker run</code> </a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note> <important> <p>Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.</p> </important>"
"documentation":"<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to <code>bridge</code>. The <code>name:internalName</code> construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to <a href=\"https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/\">https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/run/\"> <code>docker run</code> </a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note> <important> <p>Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.</p> </important>"
},
"portMappings":{
"shape":"PortMappingList",
"documentation":"<p>The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.</p> <p>For task definitions that use the <code>awsvpc</code> network mode, you should only specify the <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than <code>localhost</code>. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. </p> <p>This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you can't specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description for a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
"documentation":"<p>The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.</p> <p>For task definitions that use the <code>awsvpc</code> network mode, you should only specify the <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than <code>localhost</code>. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. </p> <p>This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you can't specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
},
"essential":{
"shape":"BoxedBoolean",
@ -846,23 +850,23 @@
},
"entryPoint":{
"shape":"StringList",
"documentation":"<important> <p>Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead.</p> </important> <p>The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#entrypoint\">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>"
"documentation":"<important> <p>Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead.</p> </important> <p>The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#entrypoint\">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>"
},
"command":{
"shape":"StringList",
"documentation":"<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>"
"documentation":"<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>"
},
"environment":{
"shape":"EnvironmentVariables",
"documentation":"<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important>"
"documentation":"<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important>"
},
"mountPoints":{
"shape":"MountPointList",
"documentation":"<p>The mount points for data volumes in your container.</p> <p>This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.</p>"
"documentation":"<p>The mount points for data volumes in your container.</p> <p>This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.</p>"
},
"volumesFrom":{
"shape":"VolumeFromList",
"documentation":"<p>Data volumes to mount from another container. This parameter maps to <code>VolumesFrom</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"documentation":"<p>Data volumes to mount from another container. This parameter maps to <code>VolumesFrom</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--volumes-from</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"linuxParameters":{
"shape":"LinuxParameters",
@ -870,59 +874,59 @@
},
"hostname":{
"shape":"String",
"documentation":"<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The <code>hostname</code> parameter is not supported if using the <code>awsvpc</code> networkMode.</p> </note>"
"documentation":"<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The <code>hostname</code> parameter is not supported if using the <code>awsvpc</code> networkMode.</p> </note>"
},
"user":{
"shape":"String",
"documentation":"<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"workingDirectory":{
"shape":"String",
"documentation":"<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"documentation":"<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
},
"disableNetworking":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"privileged":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
"documentation":"<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
},
"readonlyRootFilesystem":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"dnsServers":{
"shape":"StringList",
"documentation":"<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"dnsSearchDomains":{
"shape":"StringList",
"documentation":"<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"extraHosts":{
"shape":"HostEntryList",
"documentation":"<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts you want the container to talk to. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts to which the container can talk. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"dockerSecurityOptions":{
"shape":"StringList",
"documentation":"<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"dockerLabels":{
"shape":"DockerLabelsMap",
"documentation":"<p>A key/value map of labels to add to the container. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--label</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
"documentation":"<p>A key/value map of labels to add to the container. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--label</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
},
"ulimits":{
"shape":"UlimitList",
"documentation":"<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
"documentation":"<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
},
"logConfiguration":{
"shape":"LogConfiguration",
"documentation":"<p>The log configuration specification for the container.</p> <p>If using the Fargate launch type, the only supported value is <code>awslogs</code>.</p> <p>This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
"documentation":"<p>The log configuration specification for the container.</p> <p>If using the Fargate launch type, the only supported value is <code>awslogs</code>.</p> <p>This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
},
"healthCheck":{
"shape":"HealthCheck",
"documentation":"<p>The health check command and associated configuration parameters for the container. This parameter maps to <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>HEALTHCHECK</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"documentation":"<p>The health check command and associated configuration parameters for the container. This parameter maps to <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>HEALTHCHECK</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
}
},
"documentation":"<p>Container definitions are used in task definitions to describe the different containers that are launched as part of a task.</p>"
@ -936,7 +940,7 @@
"members":{
"containerInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
},
"ec2InstanceId":{
"shape":"String",
@ -964,7 +968,7 @@
},
"agentConnected":{
"shape":"Boolean",
"documentation":"<p>This parameter returns <code>true</code> if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return <code>false</code>. Instances without a connected agent can't accept placement requests.</p>"
"documentation":"<p>This parameter returns <code>true</code> if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return <code>false</code>. Only instances connected to an agent can accept placement requests.</p>"
},
"runningTasksCount":{
"shape":"Integer",
@ -988,7 +992,7 @@
},
"attachments":{
"shape":"Attachments",
"documentation":"<p>The Elastic Network Interfaces associated with the container instance.</p>"
"documentation":"<p>The elastic network interfaces associated with the container instance.</p>"
}
},
"documentation":"<p>An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.</p>"
@ -1103,7 +1107,7 @@
},
"serviceName":{
"shape":"String",
"documentation":"<p>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.</p>"
"documentation":"<p>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.</p>"
},
"taskDefinition":{
"shape":"String",
@ -1115,7 +1119,7 @@
},
"serviceRegistries":{
"shape":"ServiceRegistries",
"documentation":"<p>The details of the service discovery registries you want to assign to this service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p> <note> <p>Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a>.</p> </note>"
"documentation":"<p>The details of the service discovery registries to assign to this service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p> <note> <p>Service discovery is supported for Fargate tasks if using platform version v1.1.0 or later. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a>.</p> </note>"
},
"desiredCount":{
"shape":"BoxedInteger",
@ -1155,7 +1159,7 @@
},
"healthCheckGracePeriodSeconds":{
"shape":"BoxedInteger",
"documentation":"<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
"documentation":"<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
},
"schedulingStrategy":{
"shape":"SchedulingStrategy",
@ -1286,7 +1290,7 @@
},
"networkConfiguration":{
"shape":"NetworkConfiguration",
"documentation":"<p>The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the <code>awsvpc</code> networking mode.</p>"
"documentation":"<p>The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the <code>awsvpc</code> networking mode.</p>"
}
},
"documentation":"<p>The details of an Amazon ECS service deployment.</p>"
@ -1319,7 +1323,7 @@
},
"containerInstance":{
"shape":"String",
"documentation":"<p>The container instance ID or full ARN of the container instance to deregister. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
"documentation":"<p>The container instance ID or full ARN of the container instance to deregister. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
},
"force":{
"shape":"BoxedBoolean",
@ -1529,7 +1533,7 @@
"members":{
"containerInstance":{
"shape":"String",
"documentation":"<p>The container instance ID or full ARN of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
"documentation":"<p>The container instance ID or full ARN of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>"
},
"cluster":{
"shape":"String",
@ -1555,6 +1559,32 @@
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"DockerVolumeConfiguration":{
"type":"structure",
"members":{
"scope":{
"shape":"Scope",
"documentation":"<p>The scope for the Docker volume which determines it's lifecycle. Docker volumes that are scoped to a <code>task</code> are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as <code>shared</code> persist after the task stops.</p>"
},
"autoprovision":{
"shape":"BoxedBoolean",
"documentation":"<p>If this value is <code>true</code>, the Docker volume is created if it does not already exist.</p> <note> <p>This field is only used if the <code>scope</code> is <code>shared</code>.</p> </note>"
},
"driver":{
"shape":"String",
"documentation":"<p>The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use <code>docker plugin ls</code> to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see <a href=\"https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery\">Docker plugin discovery</a>. This parameter maps to <code>Driver</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxdriver</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\"> <code>docker volume create</code> </a>.</p>"
},
"driverOpts":{
"shape":"StringMap",
"documentation":"<p>A map of Docker driver specific options passed through. This parameter maps to <code>DriverOpts</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxopt</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\"> <code>docker volume create</code> </a>.</p>"
},
"labels":{
"shape":"StringMap",
"documentation":"<p>Custom metadata to add to your Docker volume. This parameter maps to <code>Labels</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxlabel</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\"> <code>docker volume create</code> </a>.</p>"
}
},
"documentation":"<p>The configuration for the Docker volume. This parameter is specified when using Docker volumes.</p>"
},
"Double":{"type":"double"},
"EnvironmentVariables":{
"type":"list",
@ -1584,7 +1614,7 @@
"members":{
"command":{
"shape":"StringList",
"documentation":"<p>A string array representing the command that the container runs to determine if it is healthy. The string array must start with <code>CMD</code> to execute the command arguments directly, or <code>CMD-SHELL</code> to run the command with the container's default shell. For example:</p> <p> <code>[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]</code> </p> <p>An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a>.</p>"
"documentation":"<p>A string array representing the command that the container runs to determine if it is healthy. The string array must start with <code>CMD</code> to execute the command arguments directly, or <code>CMD-SHELL</code> to run the command with the container's default shell. For example:</p> <p> <code>[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]</code> </p> <p>An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see <code>HealthCheck</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a>.</p>"
},
"interval":{
"shape":"BoxedInteger",
@ -1592,11 +1622,11 @@
},
"timeout":{
"shape":"BoxedInteger",
"documentation":"<p>The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds.</p>"
"documentation":"<p>The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.</p>"
},
"retries":{
"shape":"BoxedInteger",
"documentation":"<p>The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3 retries.</p>"
"documentation":"<p>The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.</p>"
},
"startPeriod":{
"shape":"BoxedInteger",
@ -1640,10 +1670,10 @@
"members":{
"sourcePath":{
"shape":"String",
"documentation":"<p>The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p> <p>If you are using the Fargate launch type, the <code>sourcePath</code> parameter is not supported.</p>"
"documentation":"<p>When the <code>host</code> parameter is used, specify a <code>sourcePath</code> to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p> <p>If you are using the Fargate launch type, the <code>sourcePath</code> parameter is not supported.</p>"
}
},
"documentation":"<p>Details on a container instance host volume.</p>"
"documentation":"<p>Details on a container instance bind mount host volume.</p>"
},
"Integer":{"type":"integer"},
"InvalidParameterException":{
@ -1658,11 +1688,11 @@
"members":{
"add":{
"shape":"StringList",
"documentation":"<p>The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to <code>CapAdd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--cap-add</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you are using tasks that use the Fargate launch type, the <code>add</code> parameter is not supported.</p> </note> <p>Valid values: <code>\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"</code> </p>"
"documentation":"<p>The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to <code>CapAdd</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--cap-add</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you are using tasks that use the Fargate launch type, the <code>add</code> parameter is not supported.</p> </note> <p>Valid values: <code>\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"</code> </p>"
},
"drop":{
"shape":"StringList",
"documentation":"<p>The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to <code>CapDrop</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--cap-drop</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Valid values: <code>\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"</code> </p>"
"documentation":"<p>The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to <code>CapDrop</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--cap-drop</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Valid values: <code>\"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"</code> </p>"
}
},
"documentation":"<p>The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see <a href=\"https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities\">Runtime privilege and Linux capabilities</a> in the <i>Docker run reference</i>. For more detailed information on these Linux capabilities, see the <a href=\"http://man7.org/linux/man-pages/man7/capabilities.7.html\">capabilities(7)</a> Linux manual page.</p>"
@ -1697,7 +1727,7 @@
},
"devices":{
"shape":"DevicesList",
"documentation":"<p>Any host devices to expose to the container. This parameter maps to <code>Devices</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--device</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you are using tasks that use the Fargate launch type, the <code>devices</code> parameter is not supported.</p> </note>"
"documentation":"<p>Any host devices to expose to the container. This parameter maps to <code>Devices</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--device</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you are using tasks that use the Fargate launch type, the <code>devices</code> parameter is not supported.</p> </note>"
},
"initProcessEnabled":{
"shape":"BoxedBoolean",
@ -1838,7 +1868,7 @@
},
"launchType":{
"shape":"LaunchType",
"documentation":"<p>The launch type for services you want to list.</p>"
"documentation":"<p>The launch type for the services to list.</p>"
},
"schedulingStrategy":{
"shape":"SchedulingStrategy",
@ -1968,7 +1998,7 @@
},
"launchType":{
"shape":"LaunchType",
"documentation":"<p>The launch type for services you want to list.</p>"
"documentation":"<p>The launch type for services to list.</p>"
}
}
},
@ -2056,7 +2086,7 @@
"members":{
"sourceVolume":{
"shape":"String",
"documentation":"<p>The name of the volume to mount.</p>"
"documentation":"<p>The name of the volume to mount. Must be a volume name referenced in the <code>name</code> parameter of task definition <code>volume</code>.</p>"
},
"containerPath":{
"shape":"String",
@ -2104,7 +2134,7 @@
"members":{
"awsvpcConfiguration":{
"shape":"AwsVpcConfiguration",
"documentation":"<p>The VPC subnets and security groups associated with a task.</p>"
"documentation":"<p>The VPC subnets and security groups associated with a task.</p> <note> <p>All specified subnets and security groups must be from the same VPC.</p> </note>"
}
},
"documentation":"<p>An object representing the network configuration for a task or service.</p>"
@ -2125,7 +2155,7 @@
"documentation":"<p>The private IPv6 address for the network interface.</p>"
}
},
"documentation":"<p>An object representing the Elastic Network Interface for tasks that use the <code>awsvpc</code> network mode.</p>"
"documentation":"<p>An object representing the elastic network interface for tasks that use the <code>awsvpc</code> network mode.</p>"
},
"NetworkInterfaces":{
"type":"list",
@ -2156,7 +2186,7 @@
},
"expression":{
"shape":"String",
"documentation":"<p>A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is <code>distinctInstance</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is <code>distinctInstance</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>An object representing a constraint on task placement. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html\">Task Placement Constraints</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
@ -2202,7 +2232,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The specified platform version does not satisfy the task definition’s required capabilities.</p>",
"documentation":"<p>The specified platform version does not satisfy the task definition's required capabilities.</p>",
"exception":true
},
"PlatformUnknownException":{
@ -2340,11 +2370,11 @@
},
"cpu":{
"shape":"String",
"documentation":"<p>The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example <code>1024</code>, or as a string using vCPUs, for example <code>1 vCPU</code> or <code>1 vcpu</code>, in a task definition but will be converted to an integer indicating the CPU units when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If using the EC2 launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code> CPU units (<code>10</code> vCPUs).</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> </ul>"
"documentation":"<p>The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example <code>1024</code>, or as a string using vCPUs, for example <code>1 vCPU</code> or <code>1 vcpu</code>, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If using the EC2 launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code> CPU units (<code>10</code> vCPUs).</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> </ul>"
},
"memory":{
"shape":"String",
"documentation":"<p>The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example <code>1024</code>, or as a string using GB, for example <code>1GB</code> or <code>1 GB</code>, in a task definition but will be converted to an integer indicating the MiB when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If using the EC2 launch type, this field is optional.</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>"
"documentation":"<p>The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example <code>1024</code>, or as a string using GB, for example <code>1GB</code> or <code>1 GB</code>, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If using the EC2 launch type, this field is optional.</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>"
}
}
},
@ -2357,6 +2387,17 @@
}
}
},
"RepositoryCredentials":{
"type":"structure",
"required":["credentialsParameter"],
"members":{
"credentialsParameter":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) or name of the secret containing the private repository credentials.</p>"
}
},
"documentation":"<p>The repository credentials for private registry authentication.</p>"
},
"RequiresAttributes":{
"type":"list",
"member":{"shape":"Attribute"}
@ -2465,6 +2506,13 @@
"DAEMON"
]
},
"Scope":{
"type":"string",
"enum":[
"task",
"shared"
]
},
"ServerException":{
"type":"structure",
"members":{
@ -2479,11 +2527,11 @@
"members":{
"serviceArn":{
"shape":"String",
"documentation":"<p>The ARN that identifies the service. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the service, the AWS account ID of the service owner, the <code>service</code> namespace, and then the service name. For example, <code>arn:aws:ecs:<i>region</i>:<i>012345678910</i>:service/<i>my-service</i> </code>.</p>"
"documentation":"<p>The ARN that identifies the service. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the Region of the service, the AWS account ID of the service owner, the <code>service</code> namespace, and then the service name. For example, <code>arn:aws:ecs:<i>region</i>:<i>012345678910</i>:service/<i>my-service</i> </code>.</p>"
},
"serviceName":{
"shape":"String",
"documentation":"<p>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.</p>"
"documentation":"<p>The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.</p>"
},
"clusterArn":{
"shape":"String",
@ -2555,7 +2603,7 @@
},
"networkConfiguration":{
"shape":"NetworkConfiguration",
"documentation":"<p>The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the <code>awsvpc</code> networking mode.</p>"
"documentation":"<p>The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the <code>awsvpc</code> networking mode.</p>"
},
"healthCheckGracePeriodSeconds":{
"shape":"BoxedInteger",
@ -2674,7 +2722,7 @@
},
"networkConfiguration":{
"shape":"NetworkConfiguration",
"documentation":"<p>The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the <code>awsvpc</code> networking mode.</p>"
"documentation":"<p>The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the <code>awsvpc</code> networking mode.</p>"
}
}
},
@ -2727,6 +2775,11 @@
"type":"list",
"member":{"shape":"String"}
},
"StringMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"SubmitContainerStateChangeRequest":{
"type":"structure",
"members":{
@ -2855,19 +2908,19 @@
},
"lastStatus":{
"shape":"String",
"documentation":"<p>The last known status of the task.</p>"
"documentation":"<p>The last known status of the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_life_cycle.html\">Task Lifecycle</a>.</p>"
},
"desiredStatus":{
"shape":"String",
"documentation":"<p>The desired status of the task.</p>"
"documentation":"<p>The desired status of the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_life_cycle.html\">Task Lifecycle</a>.</p>"
},
"cpu":{
"shape":"String",
"documentation":"<p>The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example <code>1024</code>, or as a string using vCPUs, for example <code>1 vCPU</code> or <code>1 vcpu</code>, in a task definition but is converted to an integer indicating the CPU units when the task definition is registered.</p> <p>If using the EC2 launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code> CPU units (<code>10</code> vCPUs).</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> </ul>"
"documentation":"<p>The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example <code>1024</code>, or as a string using vCPUs, for example <code>1 vCPU</code> or <code>1 vcpu</code>, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.</p> <p>If using the EC2 launch type, this field is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code> vCPUs) and <code>10240</code> CPU units (<code>10</code> vCPUs).</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p> </li> </ul>"
},
"memory":{
"shape":"String",
"documentation":"<p>The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example <code>1024</code>, or as a string using GB, for example <code>1GB</code> or <code>1 GB</code>, in a task definition but is converted to an integer indicating the MiB when the task definition is registered.</p> <p>If using the EC2 launch type, this field is optional.</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>"
"documentation":"<p>The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example <code>1024</code>, or as a string using GB, for example <code>1GB</code> or <code>1 GB</code>, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.</p> <p>If using the EC2 launch type, this field is optional.</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>"
},
"containers":{
"shape":"Containers",
@ -2915,7 +2968,7 @@
},
"stoppingAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix time stamp for when the task will stop (transitions from the <code>RUNNING</code> state to <code>STOPPED</code>).</p>"
"documentation":"<p>The Unix time stamp for when the task stops (transitions from the <code>RUNNING</code> state to <code>STOPPED</code>).</p>"
},
"stoppedAt":{
"shape":"Timestamp",
@ -2935,7 +2988,7 @@
},
"attachments":{
"shape":"Attachments",
"documentation":"<p>The Elastic Network Adapter associated with the task if the task uses the <code>awsvpc</code> network mode.</p>"
"documentation":"<p>The elastic network adapter associated with the task if the task uses the <code>awsvpc</code> network mode.</p>"
},
"healthStatus":{
"shape":"HealthStatus",
@ -3079,7 +3132,7 @@
"members":{
"containerPath":{
"shape":"String",
"documentation":"<p>The absolute file path where the tmpfs volume will be mounted.</p>"
"documentation":"<p>The absolute file path where the tmpfs volume is to be mounted.</p>"
},
"size":{
"shape":"Integer",
@ -3087,7 +3140,7 @@
},
"mountOptions":{
"shape":"StringList",
"documentation":"<p>The list of tmpfs volume mount options.</p> <p>Valid values: <code>\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\"</code> </p>"
"documentation":"<p>The list of tmpfs volume mount options.</p> <p>Valid values: <code>\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"</code> </p>"
}
},
"documentation":"<p>The container path, mount options, and size of the tmpfs mount.</p>"
@ -3251,7 +3304,7 @@
},
"platformVersion":{
"shape":"String",
"documentation":"<p>The platform version you want to update your service to run.</p>"
"documentation":"<p>The platform version that your service should run.</p>"
},
"forceNewDeployment":{
"shape":"Boolean",
@ -3299,10 +3352,14 @@
},
"host":{
"shape":"HostVolumeProperties",
"documentation":"<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount <code>C:\\my\\path:C:\\my\\path</code> and <code>D:\\:D:\\</code>, but not <code>D:\\my\\path:C:\\my\\path</code> or <code>D:\\:C:\\my\\path</code>.</p>"
"documentation":"<p>This parameter is specified when using bind mount host volumes. Bind mount host volumes are supported when using either the EC2 or Fargate launch types. The contents of the <code>host</code> parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the <code>host</code> parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount <code>C:\\my\\path:C:\\my\\path</code> and <code>D:\\:D:\\</code>, but not <code>D:\\my\\path:C:\\my\\path</code> or <code>D:\\:C:\\my\\path</code>.</p>"
},
"dockerVolumeConfiguration":{
"shape":"DockerVolumeConfiguration",
"documentation":"<p>The configuration for the Docker volume. This parameter is specified when using Docker volumes.</p>"
}
},
"documentation":"<p>A data volume used in a task definition.</p>"
"documentation":"<p>A data volume used in a task definition. For tasks that use a Docker volume, specify a <code>DockerVolumeConfiguration</code>. For tasks that use a bind mount host volume, specify a <code>host</code> and optional <code>sourcePath</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguideusing_data_volumes.html\">Using Data Volumes in Tasks</a>.</p>"
},
"VolumeFrom":{
"type":"structure",

125
botocore/data/efs/2015-02-01/service-2.json
View file

@ -24,7 +24,9 @@
{"shape":"BadRequest"},
{"shape":"InternalServerError"},
{"shape":"FileSystemAlreadyExists"},
{"shape":"FileSystemLimitExceeded"}
{"shape":"FileSystemLimitExceeded"},
{"shape":"InsufficientThroughputCapacity"},
{"shape":"ThroughputLimitExceeded"}
],
"documentation":"<p>Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:</p> <ul> <li> <p>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state <code>creating</code>.</p> </li> <li> <p>Returns with the description of the created file system.</p> </li> </ul> <p>Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system.</p> <note> <p>For basic use cases, you can use a randomly generated UUID for the creation token.</p> </note> <p> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error.</p> <note> <p>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still <code>creating</code>. You can check the file system creation status by calling the <a>DescribeFileSystems</a> operation, which among other things returns the file system state.</p> </note> <p>This operation also takes an optional <code>PerformanceMode</code> parameter that you choose for your file system. We recommend <code>generalPurpose</code> performance mode for most file systems. File systems using the <code>maxIO</code> performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html\">Amazon EFS: Performance Modes</a>.</p> <p>After the file system is fully created, Amazon EFS sets its lifecycle state to <code>available</code>, at which point you can create one or more mount targets for the file system in your VPC. For more information, see <a>CreateMountTarget</a>. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. </p> <p> This operation requires permissions for the <code>elasticfilesystem:CreateFileSystem</code> action. </p>"
},
@ -198,6 +200,26 @@
{"shape":"SecurityGroupNotFound"}
],
"documentation":"<p>Modifies the set of security groups in effect for a mount target.</p> <p>When you create a mount target, Amazon EFS also creates a new network interface. For more information, see <a>CreateMountTarget</a>. This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not <code>deleted</code>. </p> <p>The operation requires permissions for the following actions:</p> <ul> <li> <p> <code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </p> </li> <li> <p> <code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </p> </li> </ul>"
},
"UpdateFileSystem":{
"name":"UpdateFileSystem",
"http":{
"method":"PUT",
"requestUri":"/2015-02-01/file-systems/{FileSystemId}",
"responseCode":202
},
"input":{"shape":"UpdateFileSystemRequest"},
"output":{"shape":"FileSystemDescription"},
"errors":[
{"shape":"BadRequest"},
{"shape":"FileSystemNotFound"},
{"shape":"IncorrectFileSystemLifeCycleState"},
{"shape":"InsufficientThroughputCapacity"},
{"shape":"InternalServerError"},
{"shape":"ThroughputLimitExceeded"},
{"shape":"TooManyRequests"}
],
"documentation":"<p>Updates the throughput mode or the amount of provisioned throughput of an existing file system.</p>"
}
},
"shapes":{
@ -227,11 +249,19 @@
},
"Encrypted":{
"shape":"Encrypted",
"documentation":"<p>A boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a <a>CreateFileSystemRequest$KmsKeyId</a> for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, <code>/aws/elasticfilesystem</code>, is used to protect the encrypted file system. </p>"
"documentation":"<p>A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a <a>CreateFileSystemRequest$KmsKeyId</a> for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, <code>/aws/elasticfilesystem</code>, is used to protect the encrypted file system. </p>"
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This id can be in one of the following formats:</p> <ul> <li> <p>Key ID - A unique identifier of the key. For example, <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>ARN - An Amazon Resource Name for the key. For example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>Key alias - A previously created display name for a key. For example, <code>alias/projectKey1</code>.</p> </li> <li> <p>Key alias ARN - An Amazon Resource Name for a key alias. For example, <code>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</code>.</p> </li> </ul> <p>Note that if the KmsKeyId is specified, the <a>CreateFileSystemRequest$Encrypted</a> parameter must be set to true.</p>"
"documentation":"<p>The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:</p> <ul> <li> <p>Key ID - A unique identifier of the key, for example, <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>ARN - An Amazon Resource Name (ARN) for the key, for example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>Key alias - A previously created display name for a key. For example, <code>alias/projectKey1</code>.</p> </li> <li> <p>Key alias ARN - An ARN for a key alias, for example, <code>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</code>.</p> </li> </ul> <p>If KmsKeyId is specified, the <a>CreateFileSystemRequest$Encrypted</a> parameter must be set to true.</p>"
},
"ThroughputMode":{
"shape":"ThroughputMode",
"documentation":"<p>The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.</p>"
},
"ProvisionedThroughputInMibps":{
"shape":"ProvisionedThroughputInMibps",
"documentation":"<p>The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits\">Amazon EFS Limits That You Can Increase</a> in the <i>Amazon EFS User Guide.</i> </p>"
}
}
},
@ -569,7 +599,7 @@
},
"SizeInBytes":{
"shape":"FileSystemSize",
"documentation":"<p>Latest known metered size (in bytes) of data stored in the file system, in bytes, in its <code>Value</code> field, and the time at which that size was determined in its <code>Timestamp</code> field. The <code>Timestamp</code> value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time. </p>"
"documentation":"<p>Latest known metered size (in bytes) of data stored in the file system, in its <code>Value</code> field, and the time at which that size was determined in its <code>Timestamp</code> field. The <code>Timestamp</code> value is the integer number of seconds since 1970-01-01T00:00:00Z. The <code>SizeInBytes</code> value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, <code>SizeInBytes</code> represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time. </p>"
},
"PerformanceMode":{
"shape":"PerformanceMode",
@ -577,11 +607,19 @@
},
"Encrypted":{
"shape":"Encrypted",
"documentation":"<p>A boolean value that, if true, indicates that the file system is encrypted.</p>"
"documentation":"<p>A Boolean value that, if true, indicates that the file system is encrypted.</p>"
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.</p>"
"documentation":"<p>The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.</p>"
},
"ThroughputMode":{
"shape":"ThroughputMode",
"documentation":"<p>The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.</p>"
},
"ProvisionedThroughputInMibps":{
"shape":"ProvisionedThroughputInMibps",
"documentation":"<p>The throughput, measured in MiB/s, that you want to provision for a file system. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits\">Amazon EFS Limits That You Can Increase</a> in the <i>Amazon EFS User Guide.</i> </p>"
}
},
"documentation":"<p>Description of the file system.</p>"
@ -609,7 +647,7 @@
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the AWS account has already created maximum number of file systems allowed per account.</p>",
"documentation":"<p>Returned if the AWS account has already created the maximum number of file systems allowed per account.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
@ -620,7 +658,7 @@
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the specified <code>FileSystemId</code> does not exist in the requester's AWS account.</p>",
"documentation":"<p>Returned if the specified <code>FileSystemId</code> value doesn't exist in the requester's AWS account.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
@ -650,7 +688,7 @@
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the file system's life cycle state is not \"created\".</p>",
"documentation":"<p>Returned if the file system's lifecycle state is not \"available\".</p>",
"error":{"httpStatusCode":409},
"exception":true
},
@ -665,6 +703,17 @@
"error":{"httpStatusCode":409},
"exception":true
},
"InsufficientThroughputCapacity":{
"type":"structure",
"required":["ErrorCode"],
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from bursting to provisioned throughput mode.</p>",
"error":{"httpStatusCode":503},
"exception":true
},
"InternalServerError":{
"type":"structure",
"required":["ErrorCode"],
@ -698,6 +747,7 @@
"enum":[
"creating",
"available",
"updating",
"deleting",
"deleted"
]
@ -803,7 +853,7 @@
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p> The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html\">Amazon VPC Limits</a> in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table). </p>",
"documentation":"<p>The calling account has reached the limit for elastic network interfaces for the specific AWS Region. The client should try to delete some elastic network interfaces or get the account limit raised. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Appendix_Limits.html\">Amazon VPC Limits</a> in the <i>Amazon VPC User Guide </i> (see the Network interfaces per VPC entry in the table). </p>",
"error":{"httpStatusCode":409},
"exception":true
},
@ -825,6 +875,10 @@
"maxIO"
]
},
"ProvisionedThroughputInMibps":{
"type":"double",
"min":0.0
},
"SecurityGroup":{"type":"string"},
"SecurityGroupLimitExceeded":{
"type":"structure",
@ -844,7 +898,7 @@
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if one of the specified security groups does not exist in the subnet's VPC.</p>",
"documentation":"<p>Returned if one of the specified security groups doesn't exist in the subnet's VPC.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -900,7 +954,36 @@
"type":"list",
"member":{"shape":"Tag"}
},
"ThroughputLimitExceeded":{
"type":"structure",
"required":["ErrorCode"],
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ThroughputMode":{
"type":"string",
"enum":[
"bursting",
"provisioned"
]
},
"Timestamp":{"type":"timestamp"},
"TooManyRequests":{
"type":"structure",
"required":["ErrorCode"],
"members":{
"ErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if you don’t wait at least 24 hours before changing the throughput mode, or decreasing the Provisioned Throughput value.</p>",
"error":{"httpStatusCode":429},
"exception":true
},
"UnsupportedAvailabilityZone":{
"type":"structure",
"required":["ErrorCode"],
@ -911,6 +994,26 @@
"documentation":"<p/>",
"error":{"httpStatusCode":400},
"exception":true
},
"UpdateFileSystemRequest":{
"type":"structure",
"required":["FileSystemId"],
"members":{
"FileSystemId":{
"shape":"FileSystemId",
"documentation":"<p>The ID of the file system that you want to update.</p>",
"location":"uri",
"locationName":"FileSystemId"
},
"ThroughputMode":{
"shape":"ThroughputMode",
"documentation":"<p>(Optional) The throughput mode that you want your file system to use. If you're not updating your throughput mode, you don't need to provide this value in your request.</p>"
},
"ProvisionedThroughputInMibps":{
"shape":"ProvisionedThroughputInMibps",
"documentation":"<p>(Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request.</p>"
}
}
}
},
"documentation":"<fullname>Amazon Elastic File System</fullname> <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the <a href=\"http://docs.aws.amazon.com/efs/latest/ug/api-reference.html\">User Guide</a>.</p>"

149
botocore/data/elbv2/2015-12-01/service-2.json
View file

@ -167,7 +167,7 @@
"errors":[
{"shape":"ListenerNotFoundException"}
],
"documentation":"<p>Deletes the specified listener.</p> <p>Alternatively, your listener is deleted when you delete the load balancer it is attached to using <a>DeleteLoadBalancer</a>.</p>"
"documentation":"<p>Deletes the specified listener.</p> <p>Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using <a>DeleteLoadBalancer</a>.</p>"
},
"DeleteLoadBalancer":{
"name":"DeleteLoadBalancer",
@ -598,7 +598,7 @@
{"shape":"InvalidConfigurationRequestException"},
{"shape":"InvalidSubnetException"}
],
"documentation":"<p>Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.</p> <p>Note that Network Load Balancers must use <code>ipv4</code>.</p>"
"documentation":"<p>Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.</p> <p>Network Load Balancers must use <code>ipv4</code>.</p>"
},
"SetRulePriorities":{
"name":"SetRulePriorities",
@ -634,7 +634,7 @@
{"shape":"InvalidConfigurationRequestException"},
{"shape":"InvalidSecurityGroupException"}
],
"documentation":"<p>Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.</p> <p>Note that you can't specify a security group for a Network Load Balancer.</p>"
"documentation":"<p>Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.</p> <p>You can't specify a security group for a Network Load Balancer.</p>"
},
"SetSubnets":{
"name":"SetSubnets",
@ -655,7 +655,7 @@
{"shape":"AllocationIdNotFoundException"},
{"shape":"AvailabilityZoneNotSupportedException"}
],
"documentation":"<p>Enables the Availability Zone for the specified public subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.</p> <p>Note that you can't change the subnets for a Network Load Balancer.</p>"
"documentation":"<p>Enables the Availability Zone for the specified public subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.</p> <p>You can't change the subnets for a Network Load Balancer.</p>"
}
},
"shapes":{
@ -665,11 +665,11 @@
"members":{
"Type":{
"shape":"ActionTypeEnum",
"documentation":"<p>The type of action. Each rule must include one forward action.</p>"
"documentation":"<p>The type of action. Each rule must include exactly one of the following types of actions: <code>forward</code>, <code>fixed-response</code>, or <code>redirect</code>.</p>"
},
"TargetGroupArn":{
"shape":"TargetGroupArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the target group. Specify only when <code>Type</code> is <code>forward</code>.</p> <p>For a default rule, the protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the target group. Specify only when <code>Type</code> is <code>forward</code>.</p>"
},
"AuthenticateOidcConfig":{
"shape":"AuthenticateOidcActionConfig",
@ -681,7 +681,15 @@
},
"Order":{
"shape":"ActionOrder",
"documentation":"<p>The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The forward action must be performed last.</p>"
"documentation":"<p>The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The final action to be performed must be a <code>forward</code> or a <code>fixed-response</code> action.</p>"
},
"RedirectConfig":{
"shape":"RedirectActionConfig",
"documentation":"<p>[Application Load Balancer] Information for creating a redirect action. Specify only when <code>Type</code> is <code>redirect</code>.</p>"
},
"FixedResponseConfig":{
"shape":"FixedResponseActionConfig",
"documentation":"<p>[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when <code>Type</code> is <code>fixed-response</code>.</p>"
}
},
"documentation":"<p>Information about an action.</p>"
@ -696,7 +704,9 @@
"enum":[
"forward",
"authenticate-oidc",
"authenticate-cognito"
"authenticate-cognito",
"redirect",
"fixed-response"
]
},
"Actions":{
@ -1027,11 +1037,11 @@
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one default certificate. To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The actions for the default rule. The rule must include one forward action.</p> <p>If the action type is <code>forward</code>, you can specify a single target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p>"
"documentation":"<p>The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.</p> <p>If the action type is <code>forward</code>, you can specify a single target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>[HTTPS listener] If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>[HTTPS listener] If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you can redirect HTTP and HTTPS requests.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you can return a custom HTTP response.</p>"
}
}
},
@ -1066,7 +1076,7 @@
},
"Scheme":{
"shape":"LoadBalancerSchemeEnum",
"documentation":"<p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.</p> <p>The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.</p> <p>The default is an Internet-facing load balancer.</p>"
"documentation":"<p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.</p> <p>The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.</p> <p>The default is an Internet-facing load balancer.</p>"
},
"Tags":{
"shape":"TagList",
@ -1106,7 +1116,7 @@
},
"Conditions":{
"shape":"RuleConditionList",
"documentation":"<p>The conditions. Each condition specifies a field name and a single value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
"documentation":"<p>The conditions. Each condition specifies a field name and a single value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
},
"Priority":{
"shape":"RulePriority",
@ -1114,7 +1124,7 @@
},
"Actions":{
"shape":"Actions",
"documentation":"<p>The actions. Each rule must include one forward action.</p> <p>If the action type is <code>forward</code>, you can specify a single target group.</p> <p>If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p>"
"documentation":"<p>The actions. Each rule must include exactly one of the following types of actions: <code>forward</code>, <code>fixed-response</code>, or <code>redirect</code>.</p> <p>If the action type is <code>forward</code>, you can specify a single target group.</p> <p>[HTTPS listener] If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>[HTTPS listener] If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you can redirect HTTP and HTTPS requests.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you can return a custom HTTP response.</p>"
}
}
},
@ -1166,11 +1176,11 @@
},
"HealthCheckIntervalSeconds":{
"shape":"HealthCheckIntervalSeconds",
"documentation":"<p>The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. The default is 30 seconds.</p>"
"documentation":"<p>The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. The default is 30 seconds.</p>"
},
"HealthCheckTimeoutSeconds":{
"shape":"HealthCheckTimeoutSeconds",
"documentation":"<p>The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2 to 60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.</p>"
"documentation":"<p>The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2–60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.</p>"
},
"HealthyThresholdCount":{
"shape":"HealthCheckThresholdCount",
@ -1186,7 +1196,7 @@
},
"TargetType":{
"shape":"TargetTypeEnum",
"documentation":"<p>The type of target that you must specify when registering targets with this target group. The possible values are <code>instance</code> (targets are specified by instance ID) or <code>ip</code> (targets are specified by IP address). The default is <code>instance</code>. Note that you can't specify targets for a target group using both instance IDs and IP addresses.</p> <p>If the target type is <code>ip</code>, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.</p>"
"documentation":"<p>The type of target that you must specify when registering targets with this target group. The possible values are <code>instance</code> (targets are specified by instance ID) or <code>ip</code> (targets are specified by IP address). The default is <code>instance</code>. You can't specify targets for a target group using both instance IDs and IP addresses.</p> <p>If the target type is <code>ip</code>, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.</p>"
}
}
},
@ -1640,6 +1650,39 @@
},
"exception":true
},
"FixedResponseActionConfig":{
"type":"structure",
"required":["StatusCode"],
"members":{
"MessageBody":{
"shape":"FixedResponseActionMessage",
"documentation":"<p>The message.</p>"
},
"StatusCode":{
"shape":"FixedResponseActionStatusCode",
"documentation":"<p>The HTTP response code (2XX, 4XX, or 5XX).</p>"
},
"ContentType":{
"shape":"FixedResponseActionContentType",
"documentation":"<p>The content type.</p> <p>Valid Values: text/plain | text/css | text/html | application/javascript | application/json</p>"
}
},
"documentation":"<p>Information about an action that returns a custom HTTP response.</p>"
},
"FixedResponseActionContentType":{
"type":"string",
"max":32,
"min":0
},
"FixedResponseActionMessage":{
"type":"string",
"max":1024,
"min":0
},
"FixedResponseActionStatusCode":{
"type":"string",
"pattern":"^(2|4|5)\\d\\d$"
},
"HealthCheckIntervalSeconds":{
"type":"integer",
"max":300,
@ -1863,7 +1906,7 @@
},
"Scheme":{
"shape":"LoadBalancerSchemeEnum",
"documentation":"<p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.</p> <p>The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.</p>"
"documentation":"<p>The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.</p> <p>The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.</p>"
},
"VpcId":{
"shape":"VpcId",
@ -1920,7 +1963,7 @@
"members":{
"Key":{
"shape":"LoadBalancerAttributeKey",
"documentation":"<p>The name of the attribute.</p> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket for the access logs.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.</p> </li> <li> <p> <code>routing.http2.enabled</code> - Indicates whether HTTP/2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>true</code>.</p> </li> </ul> <p>The following attributes are supported by only Network Load Balancers:</p> <ul> <li> <p> <code>load_balancing.cross_zone.enabled</code> - Indicates whether cross-zone load balancing is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
"documentation":"<p>The name of the attribute.</p> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul> <p>The following attributes are supported by only Application Load Balancers:</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket for the access logs.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.</p> </li> <li> <p> <code>routing.http2.enabled</code> - Indicates whether HTTP/2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>true</code>.</p> </li> </ul> <p>The following attributes are supported by only Network Load Balancers:</p> <ul> <li> <p> <code>load_balancing.cross_zone.enabled</code> - Indicates whether cross-zone load balancing is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
},
"Value":{
"shape":"LoadBalancerAttributeValue",
@ -2008,7 +2051,7 @@
"members":{
"HttpCode":{
"shape":"HttpCode",
"documentation":"<p>The HTTP codes.</p> <p>For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").</p> <p>For Network Load Balancers, this is 200 to 399.</p>"
"documentation":"<p>The HTTP codes.</p> <p>For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").</p> <p>For Network Load Balancers, this is 200–399.</p>"
}
},
"documentation":"<p>Information to use when checking for a successful response from a target.</p>"
@ -2036,11 +2079,11 @@
},
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one certificate. To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
"documentation":"<p>[HTTPS listeners] The default SSL server certificate. You must provide exactly one default certificate. To create a certificate list, use <a>AddListenerCertificates</a>.</p>"
},
"DefaultActions":{
"shape":"Actions",
"documentation":"<p>The actions for the default rule. The rule must include one forward action.</p> <p>If the action type is <code>forward</code>, you can specify a single target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p>"
"documentation":"<p>The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.</p> <p>If the action type is <code>forward</code>, you can specify a single target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.</p> <p>[HTTPS listener] If the action type is <code>authenticate-oidc</code>, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.</p> <p>[HTTPS listener] If the action type is <code>authenticate-cognito</code>, you can use Amazon Cognito to authenticate users as they access your application.</p> <p>[Application Load Balancer] If the action type is <code>redirect</code>, you can redirect HTTP and HTTPS requests.</p> <p>[Application Load Balancer] If the action type is <code>fixed-response</code>, you can return a custom HTTP response.</p>"
}
}
},
@ -2089,7 +2132,7 @@
},
"Conditions":{
"shape":"RuleConditionList",
"documentation":"<p>The conditions. Each condition specifies a field name and a single value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
"documentation":"<p>The conditions. Each condition specifies a field name and a single value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
},
"Actions":{
"shape":"Actions",
@ -2154,7 +2197,7 @@
},
"HealthCheckIntervalSeconds":{
"shape":"HealthCheckIntervalSeconds",
"documentation":"<p>The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.</p>"
"documentation":"<p>The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5–300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.</p>"
},
"HealthCheckTimeoutSeconds":{
"shape":"HealthCheckTimeoutSeconds",
@ -2231,6 +2274,64 @@
"TCP"
]
},
"RedirectActionConfig":{
"type":"structure",
"required":["StatusCode"],
"members":{
"Protocol":{
"shape":"RedirectActionProtocol",
"documentation":"<p>The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.</p>"
},
"Port":{
"shape":"RedirectActionPort",
"documentation":"<p>The port. You can specify a value from 1 to 65535 or #{port}.</p>"
},
"Host":{
"shape":"RedirectActionHost",
"documentation":"<p>The hostname. This component is not percent-encoded. The hostname can contain #{host}.</p>"
},
"Path":{
"shape":"RedirectActionPath",
"documentation":"<p>The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.</p>"
},
"Query":{
"shape":"RedirectActionQuery",
"documentation":"<p>The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.</p>"
},
"StatusCode":{
"shape":"RedirectActionStatusCodeEnum",
"documentation":"<p>The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).</p>"
}
},
"documentation":"<p>Information about a redirect action.</p> <p>A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.</p> <p>You can reuse URI components using the following reserved keywords:</p> <ul> <li> <p>#{protocol}</p> </li> <li> <p>#{host}</p> </li> <li> <p>#{port}</p> </li> <li> <p>#{path} (the leading \"/\" is removed)</p> </li> <li> <p>#{query}</p> </li> </ul> <p>For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}&amp;value=xyz\".</p>"
},
"RedirectActionHost":{
"type":"string",
"max":128,
"min":1
},
"RedirectActionPath":{
"type":"string",
"max":128,
"min":1
},
"RedirectActionPort":{"type":"string"},
"RedirectActionProtocol":{
"type":"string",
"pattern":"^(HTTPS?|#\\{protocol\\})$"
},
"RedirectActionQuery":{
"type":"string",
"max":128,
"min":0
},
"RedirectActionStatusCodeEnum":{
"type":"string",
"enum":[
"HTTP_301",
"HTTP_302"
]
},
"RegisterTargetsInput":{
"type":"structure",
"required":[
@ -2354,7 +2455,7 @@
},
"Values":{
"shape":"ListOfString",
"documentation":"<p>The condition value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern (for example, /img/*). A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
"documentation":"<p>The condition value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters. You can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>"
}
},
"documentation":"<p>Information about a condition for a rule.</p>"

18
botocore/data/emr/2009-03-31/service-2.json
View file

@ -122,7 +122,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see <a>ListSteps</a>.</p>"
"documentation":"<p>Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. </p>"
},
"DescribeJobFlows":{
"name":"DescribeJobFlows",
@ -790,7 +790,7 @@
},
"ReleaseLabel":{
"shape":"String",
"documentation":"<p>The release label for the Amazon EMR release.</p>"
"documentation":"<p>The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form <code>emr-x.x.x</code>, where x.x.x is an Amazon EMR release version, for example, <code>emr-5.14.0</code>. For more information about Amazon EMR release versions and included application versions and features, see <a href=\"http://docs.aws.amazon.com/emr/latest/ReleaseGuide/\">http://docs.aws.amazon.com/emr/latest/ReleaseGuide/</a>. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use <code>AmiVersion</code>.</p>"
},
"AutoTerminate":{
"shape":"Boolean",
@ -1649,7 +1649,7 @@
},
"BidPrice":{
"shape":"String",
"documentation":"<p>The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.</p>"
"documentation":"<p>The maximum Spot price your are willing to pay for EC2 instances.</p> <p>An optional, nullable field that applies if the <code>MarketType</code> for the instance group is specified as <code>SPOT</code>. Specify the maximum spot price in USD. If the value is NULL and <code>SPOT</code> is specified, the maximum Spot price is set equal to the On-Demand price.</p>"
},
"InstanceType":{
"shape":"InstanceType",
@ -1712,7 +1712,7 @@
},
"BidPrice":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>Bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.</p>"
"documentation":"<p>The maximum Spot price your are willing to pay for EC2 instances.</p> <p>An optional, nullable field that applies if the <code>MarketType</code> for the instance group is specified as <code>SPOT</code>. Specify the maximum spot price in USD. If the value is NULL and <code>SPOT</code> is specified, the maximum Spot price is set equal to the On-Demand price.</p>"
},
"InstanceType":{
"shape":"InstanceType",
@ -1771,7 +1771,7 @@
},
"BidPrice":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD.</p>"
"documentation":"<p>The maximum Spot price your are willing to pay for EC2 instances.</p> <p>An optional, nullable field that applies if the <code>MarketType</code> for the instance group is specified as <code>SPOT</code>. Specified in USD. If the value is NULL and <code>SPOT</code> is specified, the maximum Spot price is set equal to the On-Demand price.</p>"
},
"InstanceType":{
"shape":"InstanceType",
@ -2180,7 +2180,7 @@
},
"AmiVersion":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>Used only for version 2.x and 3.x of Amazon EMR. The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions supported by Amazon EMR, see <a href=\"http://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf#nameddest=ami-versions-supported\">AMI Versions Supported in EMR</a> in the <i>Amazon EMR Developer Guide.</i> </p>"
"documentation":"<p>Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, <code>ReleaseLabel</code> is used. To specify a custom AMI, use <code>CustomAmiID</code>.</p>"
},
"ExecutionStatusDetail":{
"shape":"JobFlowExecutionStatusDetail",
@ -2322,7 +2322,7 @@
},
"HadoopVersion":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The Hadoop version for the cluster. Valid inputs are \"0.18\" (deprecated), \"0.20\" (deprecated), \"0.20.205\" (deprecated), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.</p>"
"documentation":"<p>Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are \"0.18\" (deprecated), \"0.20\" (deprecated), \"0.20.205\" (deprecated), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this value, the default of 0.18 is used, unless the <code>AmiVersion</code> parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.</p>"
},
"Ec2SubnetId":{
"shape":"XmlStringMaxLen256",
@ -2888,11 +2888,11 @@
},
"AmiVersion":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>For Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, the Linux AMI is determined by the <code>ReleaseLabel</code> specified or by <code>CustomAmiID</code>. The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. For details about the AMI versions currently supported in EMR version 3.x and 2.x, see <a href=\"emr/latest/DeveloperGuide/emr-dg.pdf#nameddest=ami-versions-supported\">AMI Versions Supported in EMR</a> in the <i>Amazon EMR Developer Guide</i>. </p> <p>If the AMI supports multiple versions of Hadoop (for example, AMI 1.0 supports both Hadoop 0.18 and 0.20), you can use the <a>JobFlowInstancesConfig</a> <code>HadoopVersion</code> parameter to modify the version of Hadoop from the defaults shown above.</p> <note> <p>Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later).</p> </note>"
"documentation":"<p>Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, <code>ReleaseLabel</code> is used. To specify a custom AMI, use <code>CustomAmiID</code>.</p>"
},
"ReleaseLabel":{
"shape":"XmlStringMaxLen256",
"documentation":"<p> The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use <code>AmiVersion</code> instead.</p>"
"documentation":"<p>The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form <code>emr-x.x.x</code>, where x.x.x is an Amazon EMR release version, for example, <code>emr-5.14.0</code>. For more information about Amazon EMR release versions and included application versions and features, see <a href=\"http://docs.aws.amazon.com/emr/latest/ReleaseGuide/\">http://docs.aws.amazon.com/emr/latest/ReleaseGuide/</a>. The release label applies only to Amazon EMR releases versions 4.x and later. Earlier versions use <code>AmiVersion</code>.</p>"
},
"Instances":{
"shape":"JobFlowInstancesConfig",

87
botocore/data/endpoints.json
View file

@ -92,6 +92,7 @@
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
@ -117,6 +118,18 @@
"us-east-1" : { }
}
},
"api.sagemaker" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
"apigateway" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -179,10 +192,13 @@
"athena" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
@ -237,6 +253,7 @@
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -554,6 +571,7 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"ap-southeast-2" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -795,6 +813,12 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "elasticache-fips.us-west-1.amazonaws.com"
},
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -823,6 +847,7 @@
},
"elasticfilesystem" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
@ -857,7 +882,7 @@
},
"elasticmapreduce" : {
"defaults" : {
"protocols" : [ "http", "https" ],
"protocols" : [ "https" ],
"sslCommonName" : "{region}.{service}.{dnsSuffix}"
},
"endpoints" : {
@ -953,11 +978,15 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -1020,6 +1049,7 @@
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
@ -1036,6 +1066,7 @@
"ap-northeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
},
@ -1150,6 +1181,7 @@
},
"kinesisanalytics" : {
"endpoints" : {
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
@ -1271,6 +1303,7 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
@ -1297,6 +1330,7 @@
"mediastore" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
@ -1543,6 +1577,7 @@
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1582,6 +1617,9 @@
"runtime.sagemaker" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1644,16 +1682,6 @@
"isRegionalized" : true,
"partitionEndpoint" : "us-east-1"
},
"sagemaker" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
"sdb" : {
"defaults" : {
"protocols" : [ "http", "https" ],
@ -1908,6 +1936,7 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
@ -2311,7 +2340,7 @@
},
"elasticmapreduce" : {
"defaults" : {
"protocols" : [ "http", "https" ]
"protocols" : [ "https" ]
},
"endpoints" : {
"cn-north-1" : { },
@ -2549,6 +2578,17 @@
"us-gov-west-1" : { }
}
},
"data.iot" : {
"defaults" : {
"credentialScope" : {
"service" : "iotdata"
},
"protocols" : [ "https" ]
},
"endpoints" : {
"us-gov-west-1" : { }
}
},
"directconnect" : {
"endpoints" : {
"us-gov-west-1" : { }
@ -2587,6 +2627,12 @@
},
"elasticache" : {
"endpoints" : {
"fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "elasticache-fips.us-gov-west-1.amazonaws.com"
},
"us-gov-west-1" : { }
}
},
@ -2605,7 +2651,7 @@
"elasticmapreduce" : {
"endpoints" : {
"us-gov-west-1" : {
"protocols" : [ "http", "https" ]
"protocols" : [ "https" ]
}
}
},
@ -2643,6 +2689,16 @@
"us-gov-west-1" : { }
}
},
"iot" : {
"defaults" : {
"credentialScope" : {
"service" : "execute-api"
}
},
"endpoints" : {
"us-gov-west-1" : { }
}
},
"kinesis" : {
"endpoints" : {
"us-gov-west-1" : { }
@ -2745,6 +2801,11 @@
"us-gov-west-1" : { }
}
},
"states" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"storagegateway" : {
"endpoints" : {
"us-gov-west-1" : { }

290
botocore/data/es/2015-01-01/service-2.json
View file

@ -170,6 +170,57 @@
],
"documentation":"<p>Returns information about reserved Elasticsearch instances for this account.</p>"
},
"GetCompatibleElasticsearchVersions":{
"name":"GetCompatibleElasticsearchVersions",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/es/compatibleVersions"
},
"input":{"shape":"GetCompatibleElasticsearchVersionsRequest"},
"output":{"shape":"GetCompatibleElasticsearchVersionsResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"DisabledOperationException"},
{"shape":"ValidationException"},
{"shape":"InternalException"}
],
"documentation":"<p> Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a <code> <a>DomainName</a> </code> to get all upgrade compatible Elasticsearch versions for that specific domain. </p>"
},
"GetUpgradeHistory":{
"name":"GetUpgradeHistory",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/es/upgradeDomain/{DomainName}/history"
},
"input":{"shape":"GetUpgradeHistoryRequest"},
"output":{"shape":"GetUpgradeHistoryResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"DisabledOperationException"},
{"shape":"ValidationException"},
{"shape":"InternalException"}
],
"documentation":"<p>Retrieves the complete history of the last 10 upgrades that were performed on the domain.</p>"
},
"GetUpgradeStatus":{
"name":"GetUpgradeStatus",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/es/upgradeDomain/{DomainName}/status"
},
"input":{"shape":"GetUpgradeStatusRequest"},
"output":{"shape":"GetUpgradeStatusResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"DisabledOperationException"},
{"shape":"ValidationException"},
{"shape":"InternalException"}
],
"documentation":"<p>Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.</p>"
},
"ListDomainNames":{
"name":"ListDomainNames",
"http":{
@ -280,6 +331,24 @@
{"shape":"ValidationException"}
],
"documentation":"<p>Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. </p>"
},
"UpgradeElasticsearchDomain":{
"name":"UpgradeElasticsearchDomain",
"http":{
"method":"POST",
"requestUri":"/2015-01-01/es/upgradeDomain"
},
"input":{"shape":"UpgradeElasticsearchDomainRequest"},
"output":{"shape":"UpgradeElasticsearchDomainResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"DisabledOperationException"},
{"shape":"ValidationException"},
{"shape":"InternalException"}
],
"documentation":"<p>Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.</p>"
}
},
"shapes":{
@ -421,6 +490,21 @@
},
"documentation":"<p>Status of the Cognito options for the specified Elasticsearch domain.</p>"
},
"CompatibleElasticsearchVersionsList":{
"type":"list",
"member":{"shape":"CompatibleVersionsMap"}
},
"CompatibleVersionsMap":{
"type":"structure",
"members":{
"SourceVersion":{
"shape":"ElasticsearchVersionString",
"documentation":"<p>The current version of Elasticsearch on which a domain is.</p>"
},
"TargetVersions":{"shape":"ElasticsearchVersionList"}
},
"documentation":"<p> A map from an <code> <a>ElasticsearchVersion</a> </code> to a list of compatible <code> <a>ElasticsearchVersion</a> </code> s to which the domain can be upgraded. </p>"
},
"CreateElasticsearchDomainRequest":{
"type":"structure",
"required":["DomainName"],
@ -946,6 +1030,10 @@
"shape":"Boolean",
"documentation":"<p>The status of the Elasticsearch domain configuration. <code>True</code> if Amazon Elasticsearch Service is processing configuration changes. <code>False</code> if the configuration is active.</p>"
},
"UpgradeProcessing":{
"shape":"Boolean",
"documentation":"<p>The status of an Elasticsearch domain version upgrade. <code>True</code> if Amazon Elasticsearch Service is undergoing a version upgrade. <code>False</code> if the configuration is active.</p>"
},
"ElasticsearchVersion":{"shape":"ElasticsearchVersionString"},
"ElasticsearchClusterConfig":{
"shape":"ElasticsearchClusterConfig",
@ -1062,6 +1150,93 @@
"type":"string",
"pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}"
},
"GetCompatibleElasticsearchVersionsRequest":{
"type":"structure",
"members":{
"DomainName":{
"shape":"DomainName",
"location":"querystring",
"locationName":"domainName"
}
},
"documentation":"<p> Container for request parameters to <code> <a>GetCompatibleElasticsearchVersions</a> </code> operation. </p>"
},
"GetCompatibleElasticsearchVersionsResponse":{
"type":"structure",
"members":{
"CompatibleElasticsearchVersions":{
"shape":"CompatibleElasticsearchVersionsList",
"documentation":"<p> A map of compatible Elasticsearch versions returned as part of the <code> <a>GetCompatibleElasticsearchVersions</a> </code> operation. </p>"
}
},
"documentation":"<p> Container for response returned by <code> <a>GetCompatibleElasticsearchVersions</a> </code> operation. </p>"
},
"GetUpgradeHistoryRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"location":"uri",
"locationName":"DomainName"
},
"MaxResults":{
"shape":"MaxResults",
"location":"querystring",
"locationName":"maxResults"
},
"NextToken":{
"shape":"NextToken",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"<p> Container for request parameters to <code> <a>GetUpgradeHistory</a> </code> operation. </p>"
},
"GetUpgradeHistoryResponse":{
"type":"structure",
"members":{
"UpgradeHistories":{
"shape":"UpgradeHistoryList",
"documentation":"<p> A list of <code> <a>UpgradeHistory</a> </code> objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of <code> <a>GetUpgradeHistoryResponse</a> </code> object. </p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Pagination token that needs to be supplied to the next call to get the next page of results</p>"
}
},
"documentation":"<p> Container for response returned by <code> <a>GetUpgradeHistory</a> </code> operation. </p>"
},
"GetUpgradeStatusRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"location":"uri",
"locationName":"DomainName"
}
},
"documentation":"<p> Container for request parameters to <code> <a>GetUpgradeStatus</a> </code> operation. </p>"
},
"GetUpgradeStatusResponse":{
"type":"structure",
"members":{
"UpgradeStep":{
"shape":"UpgradeStep",
"documentation":"<p> Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul> </p>"
},
"StepStatus":{
"shape":"UpgradeStatus",
"documentation":"<p> One of 4 statuses that a step can go through returned as part of the <code> <a>GetUpgradeStatusResponse</a> </code> object. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul> </p>"
},
"UpgradeName":{
"shape":"UpgradeName",
"documentation":"<p>A string that describes the update briefly</p>"
}
},
"documentation":"<p> Container for response returned by <code> <a>GetUpgradeStatus</a> </code> operation. </p>"
},
"IdentityPoolId":{
"type":"string",
"max":55,
@ -1107,6 +1282,11 @@
"error":{"httpStatusCode":409},
"exception":true
},
"Issue":{"type":"string"},
"Issues":{
"type":"list",
"member":{"shape":"Issue"}
},
"KmsKeyId":{
"type":"string",
"max":500,
@ -1282,10 +1462,11 @@
},
"LogType":{
"type":"string",
"documentation":"<p>Type of Log File, it can be one of the following: <ul> <li>INDEX_SLOW_LOGS: Index slow logs contains insert requests that took more time than configured index query log threshold to execute.</li> <li>SEARCH_SLOW_LOGS: Search slow logs contains search queries that took more time than configured search query log threshold to execute.</li> </ul> </p>",
"documentation":"<p>Type of Log File, it can be one of the following: <ul> <li>INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.</li> <li>SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.</li> <li>ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.</li> </ul> </p>",
"enum":[
"INDEX_SLOW_LOGS",
"SEARCH_SLOW_LOGS"
"SEARCH_SLOW_LOGS",
"ES_APPLICATION_LOGS"
]
},
"MaxResults":{
@ -1591,6 +1772,7 @@
},
"documentation":"<p>Status of a daily automated snapshot.</p>"
},
"StartTimestamp":{"type":"timestamp"},
"StorageSubTypeName":{
"type":"string",
"documentation":"<p> SubType of the given storage type. List of available sub-storage options: For \"instance\" storageType we wont have any storageSubType, in case of \"ebs\" storageType we will have following valid storageSubTypes <ol> <li>standard</li> <li>gp2</li> <li>io1</li> </ol> Refer <code><a>VolumeType</a></code> for more information regarding above EBS storage options. </p>"
@ -1734,6 +1916,110 @@
"documentation":"<p>The result of an <code>UpdateElasticsearchDomain</code> request. Contains the status of the Elasticsearch domain being updated.</p>"
},
"UpdateTimestamp":{"type":"timestamp"},
"UpgradeElasticsearchDomainRequest":{
"type":"structure",
"required":[
"DomainName",
"TargetVersion"
],
"members":{
"DomainName":{"shape":"DomainName"},
"TargetVersion":{
"shape":"ElasticsearchVersionString",
"documentation":"<p>The version of Elasticsearch that you intend to upgrade the domain to.</p>"
},
"PerformCheckOnly":{
"shape":"Boolean",
"documentation":"<p> This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. </p>"
}
},
"documentation":"<p> Container for request parameters to <code> <a>UpgradeElasticsearchDomain</a> </code> operation. </p>"
},
"UpgradeElasticsearchDomainResponse":{
"type":"structure",
"members":{
"DomainName":{"shape":"DomainName"},
"TargetVersion":{
"shape":"ElasticsearchVersionString",
"documentation":"<p>The version of Elasticsearch that you intend to upgrade the domain to.</p>"
},
"PerformCheckOnly":{
"shape":"Boolean",
"documentation":"<p> This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. </p>"
}
},
"documentation":"<p> Container for response returned by <code> <a>UpgradeElasticsearchDomain</a> </code> operation. </p>"
},
"UpgradeHistory":{
"type":"structure",
"members":{
"UpgradeName":{
"shape":"UpgradeName",
"documentation":"<p>A string that describes the update briefly</p>"
},
"StartTimestamp":{
"shape":"StartTimestamp",
"documentation":"<p>UTC Timestamp at which the Upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.</p>"
},
"UpgradeStatus":{
"shape":"UpgradeStatus",
"documentation":"<p> The overall status of the update. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul> </p>"
},
"StepsList":{
"shape":"UpgradeStepsList",
"documentation":"<p> A list of <code> <a>UpgradeStepItem</a> </code> s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check. </p>"
}
},
"documentation":"<p>History of the last 10 Upgrades and Upgrade Eligibility Checks.</p>"
},
"UpgradeHistoryList":{
"type":"list",
"member":{"shape":"UpgradeHistory"}
},
"UpgradeName":{"type":"string"},
"UpgradeStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"SUCCEEDED",
"SUCCEEDED_WITH_ISSUES",
"FAILED"
]
},
"UpgradeStep":{
"type":"string",
"enum":[
"PRE_UPGRADE_CHECK",
"SNAPSHOT",
"UPGRADE"
]
},
"UpgradeStepItem":{
"type":"structure",
"members":{
"UpgradeStep":{
"shape":"UpgradeStep",
"documentation":"<p> Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul> </p>"
},
"UpgradeStepStatus":{
"shape":"UpgradeStatus",
"documentation":"<p> The status of a particular step during an upgrade. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul> </p>"
},
"Issues":{
"shape":"Issues",
"documentation":"<p>A list of strings containing detailed information about the errors encountered in a particular step.</p>"
},
"ProgressPercent":{
"shape":"Double",
"documentation":"<p>The Floating point value representing progress percentage of a particular step.</p>"
}
},
"documentation":"<p>Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.</p>"
},
"UpgradeStepsList":{
"type":"list",
"member":{"shape":"UpgradeStepItem"}
},
"UserPoolId":{
"type":"string",
"max":55,

18
botocore/data/glacier/2012-06-01/service-2.json
View file

@ -352,7 +352,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.</p> <note> <p>Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.</p> </note> <p>The List Jobs operation supports pagination. You should always check the response <code>Marker</code> field. If there are no more jobs to list, the <code>Marker</code> field is set to <code>null</code>. If there are more jobs to list, the <code>Marker</code> field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the <code>Marker</code> value for that job that you obtained from a previous List Jobs request.</p> <p>You can set a maximum limit for the number of jobs returned in the response by specifying the <code>limit</code> parameter in the request. The default limit is 1000. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.</p> <p>Additionally, you can filter the jobs list returned by specifying the optional <code>statuscode</code> parameter or <code>completed</code> parameter, or both. Using the <code>statuscode</code> parameter, you can specify to return only jobs that match either the <code>InProgress</code>, <code>Succeeded</code>, or <code>Failed</code> status. Using the <code>completed</code> parameter, you can specify to return only jobs that were completed (<code>true</code>) or jobs that were not completed (<code>false</code>).</p> <p>For more information about using this operation, see the documentation for the underlying REST API <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html\">List Jobs</a>. </p>"
"documentation":"<p>This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.</p> <note> <p>Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.</p> </note> <p>The List Jobs operation supports pagination. You should always check the response <code>Marker</code> field. If there are no more jobs to list, the <code>Marker</code> field is set to <code>null</code>. If there are more jobs to list, the <code>Marker</code> field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the <code>Marker</code> value for that job that you obtained from a previous List Jobs request.</p> <p>You can set a maximum limit for the number of jobs returned in the response by specifying the <code>limit</code> parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.</p> <p>Additionally, you can filter the jobs list returned by specifying the optional <code>statuscode</code> parameter or <code>completed</code> parameter, or both. Using the <code>statuscode</code> parameter, you can specify to return only jobs that match either the <code>InProgress</code>, <code>Succeeded</code>, or <code>Failed</code> status. Using the <code>completed</code> parameter, you can specify to return only jobs that were completed (<code>true</code>) or jobs that were not completed (<code>false</code>).</p> <p>For more information about using this operation, see the documentation for the underlying REST API <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-jobs-get.html\">List Jobs</a>. </p>"
},
"ListMultipartUploads":{
"name":"ListMultipartUploads",
@ -368,7 +368,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a> request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. </p> <p>The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of multipart uploads that begins at a specific upload, set the <code>marker</code> request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the <code>limit</code> parameter in the request.</p> <p>Note the difference between this operation and listing parts (<a>ListParts</a>). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html\">List Multipart Uploads </a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
"documentation":"<p>This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an <a>InitiateMultipartUpload</a> request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order. </p> <p>The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of multipart uploads that begins at a specific upload, set the <code>marker</code> request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the <code>limit</code> parameter in the request.</p> <p>Note the difference between this operation and listing parts (<a>ListParts</a>). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-uploads.html\">List Multipart Uploads </a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
},
"ListParts":{
"name":"ListParts",
@ -384,7 +384,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. </p> <p>The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of parts that begins at a specific part, set the <code>marker</code> request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the <code>limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html\">List Parts</a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
"documentation":"<p>This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see <a>CompleteMultipartUpload</a>. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range. </p> <p>The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a <code>marker</code> at which to continue the list; if there are no more items the <code>marker</code> is <code>null</code>. To return a list of parts that begins at a specific part, set the <code>marker</code> request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the <code>limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and the underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-archives.html\">Working with Archives in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-multipart-list-parts.html\">List Parts</a> in the <i>Amazon Glacier Developer Guide</i>.</p>"
},
"ListProvisionedCapacity":{
"name":"ListProvisionedCapacity",
@ -431,7 +431,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.</p> <p>By default, this operation returns up to 1,000 items. If there are more vaults to list, the response <code>marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code>marker</code> field is <code>null</code>. To return a list of vaults that begins at a specific vault, set the <code>marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code>limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html\">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
"documentation":"<p>This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.</p> <p>By default, this operation returns up to 10 items. If there are more vaults to list, the response <code>marker</code> field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the <code>marker</code> field is <code>null</code>. To return a list of vaults that begins at a specific vault, set the <code>marker</code> request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the <code>limit</code> parameter in the request. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vaults-get.html\">List Vaults </a> in the <i>Amazon Glacier Developer Guide</i>. </p>"
},
"PurchaseProvisionedCapacity":{
"name":"PurchaseProvisionedCapacity",
@ -1745,7 +1745,7 @@
},
"limit":{
"shape":"string",
"documentation":"<p>The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.</p>",
"documentation":"<p>The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.</p>",
"location":"querystring",
"locationName":"limit"
},
@ -1811,7 +1811,7 @@
},
"limit":{
"shape":"string",
"documentation":"<p>Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.</p>",
"documentation":"<p>Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 50 uploads.</p>",
"location":"querystring",
"locationName":"limit"
}
@ -1866,7 +1866,7 @@
},
"limit":{
"shape":"string",
"documentation":"<p>The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.</p>",
"documentation":"<p>The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.</p>",
"location":"querystring",
"locationName":"limit"
}
@ -1978,7 +1978,7 @@
},
"limit":{
"shape":"string",
"documentation":"<p>The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.</p>",
"documentation":"<p>The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.</p>",
"location":"querystring",
"locationName":"limit"
}
@ -2576,5 +2576,5 @@
"long":{"type":"long"},
"string":{"type":"string"}
},
"documentation":"<p>Amazon Glacier is a storage solution for \"cold data.\"</p> <p>Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.</p> <p>Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see <a href=\"http://aws.amazon.com/s3/\">Amazon Simple Storage Service (Amazon S3)</a>.</p> <p>You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.</p> <p>If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the <i>Amazon Glacier Developer Guide</i>:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html\">What is Amazon Glacier</a> - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html\">Getting Started with Amazon Glacier</a> - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.</p> </li> </ul>"
"documentation":"<p>Amazon Glacier is a storage solution for \"cold data.\"</p> <p>Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.</p> <p>Amazon Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see <a href=\"http://aws.amazon.com/s3/\">Amazon Simple Storage Service (Amazon S3)</a>.</p> <p>You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.</p> <p>If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the <i>Amazon Glacier Developer Guide</i>:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/introduction.html\">What is Amazon Glacier</a> - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/amazon-glacier-getting-started.html\">Getting Started with Amazon Glacier</a> - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.</p> </li> </ul>"
}

27
botocore/data/glue/2017-03-31/service-2.json
View file

@ -2305,7 +2305,11 @@
},
"PublicKey":{
"shape":"GenericString",
"documentation":"<p>The public key to use for authentication.</p>"
"documentation":"<p>The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.</p>"
},
"PublicKeys":{
"shape":"PublicKeysList",
"documentation":"<p>A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.</p> <note> <p>If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the <code>UpdateDevEndpoint</code> API with the public key content in the <code>deletePublicKeys</code> attribute, and the list of new keys in the <code>addPublicKeys</code> attribute.</p> </note>"
},
"NumberOfNodes":{
"shape":"IntegerValue",
@ -3032,7 +3036,7 @@
},
"PrivateAddress":{
"shape":"GenericString",
"documentation":"<p>The private address used by this DevEndpoint.</p>"
"documentation":"<p>A private DNS to access the DevEndpoint within a VPC, if the DevEndpoint is created within one.</p>"
},
"ZeppelinRemoteSparkInterpreterPort":{
"shape":"IntegerValue",
@ -3084,7 +3088,11 @@
},
"PublicKey":{
"shape":"GenericString",
"documentation":"<p>The public key to be used by this DevEndpoint for authentication.</p>"
"documentation":"<p>The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility, as the recommended attribute to use is public keys.</p>"
},
"PublicKeys":{
"shape":"PublicKeysList",
"documentation":"<p>A list of public keys to be used by the DevEndpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.</p> <note> <p>If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys: call the <code>UpdateDevEndpoint</code> API with the public key content in the <code>deletePublicKeys</code> attribute, and the list of new keys in the <code>addPublicKeys</code> attribute.</p> </note>"
}
},
"documentation":"<p>A development endpoint where a developer can remotely debug ETL scripts.</p>"
@ -4861,6 +4869,11 @@
"GROUP"
]
},
"PublicKeysList":{
"type":"list",
"member":{"shape":"GenericString"},
"max":5
},
"PythonScript":{"type":"string"},
"ResetJobBookmarkRequest":{
"type":"structure",
@ -5737,6 +5750,14 @@
"shape":"GenericString",
"documentation":"<p>The public key for the DevEndpoint to use.</p>"
},
"AddPublicKeys":{
"shape":"PublicKeysList",
"documentation":"<p>The list of public keys for the DevEndpoint to use.</p>"
},
"DeletePublicKeys":{
"shape":"PublicKeysList",
"documentation":"<p>The list of public keys to be deleted from the DevEndpoint. </p>"
},
"CustomLibraries":{
"shape":"DevEndpointCustomLibraries",
"documentation":"<p>Custom Python or Java libraries to be loaded in the DevEndpoint.</p>"

2
botocore/data/greengrass/2017-06-07/service-2.json
View file

@ -4271,7 +4271,7 @@
},
"SourcePath" : {
"shape" : "__string",
"documentation" : "The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/proc'' or ''/sys''."
"documentation" : "The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''."
}
},
"documentation" : "Attributes that define a local volume resource."

20
botocore/data/health/2016-08-04/service-2.json
View file

@ -108,7 +108,7 @@
},
"eventArn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331</code> </p>"
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"entityValue":{
"shape":"entityValue",
@ -187,7 +187,7 @@
"members":{
"eventArns":{
"shape":"EventArnsList",
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"</code> </p>"
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"</code> </p>"
}
}
},
@ -245,7 +245,7 @@
"members":{
"eventArns":{
"shape":"eventArnList",
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"</code> </p>"
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"</code> </p>"
},
"locale":{
"shape":"locale",
@ -343,7 +343,7 @@
"members":{
"eventArn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331</code> </p>"
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"count":{
"shape":"count",
@ -362,7 +362,7 @@
"members":{
"eventArns":{
"shape":"eventArnList",
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"</code> </p>"
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"</code> </p>"
},
"entityArns":{
"shape":"entityArnList",
@ -396,7 +396,7 @@
"members":{
"arn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331</code> </p>"
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"service":{
"shape":"service",
@ -408,7 +408,7 @@
},
"eventTypeCategory":{
"shape":"eventTypeCategory",
"documentation":"<p>The </p>"
"documentation":"<p>The category of the event. Possible values are <code>issue</code>, <code>scheduledChange</code>, and <code>accountNotification</code>.</p>"
},
"region":{
"shape":"region",
@ -494,7 +494,7 @@
"members":{
"eventArn":{
"shape":"eventArn",
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331</code> </p>"
"documentation":"<p>The unique identifier for the event. Format: <code>arn:aws:health:<i>event-region</i>::event/<i>SERVICE</i>/<i>EVENT_TYPE_CODE</i>/<i>EVENT_TYPE_PLUS_ID</i> </code>. Example: <code>Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456</code> </p>"
},
"errorName":{
"shape":"string",
@ -512,7 +512,7 @@
"members":{
"eventArns":{
"shape":"eventArnList",
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"</code> </p>"
"documentation":"<p>A list of event ARNs (unique identifiers). For example: <code>\"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"</code> </p>"
},
"eventTypeCodes":{
"shape":"eventTypeList",
@ -698,7 +698,7 @@
"eventArn":{
"type":"string",
"max":1600,
"pattern":"arn:aws:health:[^:]*:[^:]*:event/[\\w-]+"
"pattern":"arn:aws:health:[^:]*:[^:]*:event(?:/[\\w-]+){1}((?:/[\\w-]+){2})?"
},
"eventArnList":{
"type":"list",

188
botocore/data/iam/2010-05-08/service-2.json
View file

@ -562,6 +562,20 @@
],
"documentation":"<p>Deletes the specified role. The role must not have any policies attached. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>.</p> <important> <p>Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.</p> </important>"
},
"DeleteRolePermissionsBoundary":{
"name":"DeleteRolePermissionsBoundary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRolePermissionsBoundaryRequest"},
"errors":[
{"shape":"NoSuchEntityException"},
{"shape":"UnmodifiableEntityException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Deletes the permissions boundary for the specified IAM role. </p> <important> <p>Deleting the permissions boundary for a role might increase its permissions by allowing anyone who assumes the role to perform all the actions granted in its permissions policies. </p> </important>"
},
"DeleteRolePolicy":{
"name":"DeleteRolePolicy",
"http":{
@ -678,6 +692,19 @@
],
"documentation":"<p>Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.</p>"
},
"DeleteUserPermissionsBoundary":{
"name":"DeleteUserPermissionsBoundary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteUserPermissionsBoundaryRequest"},
"errors":[
{"shape":"NoSuchEntityException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Deletes the permissions boundary for the specified IAM user.</p> <important> <p>Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies. </p> </important>"
},
"DeleteUserPolicy":{
"name":"DeleteUserPolicy",
"http":{
@ -1591,6 +1618,22 @@
],
"documentation":"<p>Adds or updates an inline policy document that is embedded in the specified IAM group.</p> <p>A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about limits on the number of inline policies that you can embed in a group, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>IAM User Guide</i>.</p> </note>"
},
"PutRolePermissionsBoundary":{
"name":"PutRolePermissionsBoundary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutRolePermissionsBoundaryRequest"},
"errors":[
{"shape":"NoSuchEntityException"},
{"shape":"InvalidInputException"},
{"shape":"UnmodifiableEntityException"},
{"shape":"PolicyNotAttachableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.</p> <p>You cannot set the boundary for a service-linked role. </p> <important> <p>Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html\">IAM JSON Policy Evaluation Logic</a> in the IAM User Guide. </p> </important>"
},
"PutRolePolicy":{
"name":"PutRolePolicy",
"http":{
@ -1607,6 +1650,21 @@
],
"documentation":"<p>Adds or updates an inline policy document that is embedded in the specified IAM role.</p> <p>When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about IAM roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html\">Using Roles to Delegate Permissions and Federate Identities</a>.</p> <p>A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>.</p> <p>For information about limits on the number of inline policies that you can embed with a role, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p> <note> <p>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>IAM User Guide</i>.</p> </note>"
},
"PutUserPermissionsBoundary":{
"name":"PutUserPermissionsBoundary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutUserPermissionsBoundaryRequest"},
"errors":[
{"shape":"NoSuchEntityException"},
{"shape":"InvalidInputException"},
{"shape":"PolicyNotAttachableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.</p> <important> <p>Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html\">IAM JSON Policy Evaluation Logic</a> in the IAM User Guide. </p> </important>"
},
"PutUserPolicy":{
"name":"PutUserPolicy",
"http":{
@ -1928,7 +1986,7 @@
"errors":[
{"shape":"NoSuchEntityException"}
],
"documentation":"<p>Sets the status of a service-specific credential to <code>Active</code> or <code>Inactive</code>. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user’s service-specific credential as part of a credential rotation work flow.</p>"
"documentation":"<p>Sets the status of a service-specific credential to <code>Active</code> or <code>Inactive</code>. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.</p>"
},
"UpdateSigningCertificate":{
"name":"UpdateSigningCertificate",
@ -2216,6 +2274,20 @@
}
}
},
"AttachedPermissionsBoundary":{
"type":"structure",
"members":{
"PermissionsBoundaryType":{
"shape":"PermissionsBoundaryAttachmentType",
"documentation":"<p> The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of <code>Policy</code>.</p>"
},
"PermissionsBoundaryArn":{
"shape":"arnType",
"documentation":"<p> The ARN of the policy used to set the permissions boundary for the user or role.</p>"
}
},
"documentation":"<p>Contains information about an attached permissions boundary.</p> <p>An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.</p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>"
},
"AttachedPolicy":{
"type":"structure",
"members":{
@ -2537,6 +2609,10 @@
"MaxSessionDuration":{
"shape":"roleMaxSessionDurationType",
"documentation":"<p>The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.</p> <p>Anyone who assumes the role from the AWS CLI or API can use the <code>DurationSeconds</code> API parameter or the <code>duration-seconds</code> CLI parameter to request a longer session. The <code>MaxSessionDuration</code> setting determines the maximum duration that can be requested using the <code>DurationSeconds</code> parameter. If users don't specify a value for the <code>DurationSeconds</code> parameter, their security credentials are valid for one hour by default. This applies when you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI operations but does not apply when you use those operations to create a console URL. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html\">Using IAM Roles</a> in the <i>IAM User Guide</i>.</p>"
},
"PermissionsBoundary":{
"shape":"arnType",
"documentation":"<p>The ARN of the policy that is used to set the permissions boundary for the role.</p>"
}
}
},
@ -2642,6 +2718,10 @@
"UserName":{
"shape":"userNameType",
"documentation":"<p>The name of the user to create.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. User names are not distinguished by case. For example, you cannot create users named both \"TESTUSER\" and \"testuser\".</p>"
},
"PermissionsBoundary":{
"shape":"arnType",
"documentation":"<p>The ARN of the policy that is used to set the permissions boundary for the user.</p>"
}
}
},
@ -2857,6 +2937,16 @@
}
}
},
"DeleteRolePermissionsBoundaryRequest":{
"type":"structure",
"required":["RoleName"],
"members":{
"RoleName":{
"shape":"roleNameType",
"documentation":"<p>The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary.</p>"
}
}
},
"DeleteRolePolicyRequest":{
"type":"structure",
"required":[
@ -2969,6 +3059,16 @@
}
}
},
"DeleteUserPermissionsBoundaryRequest":{
"type":"structure",
"required":["UserName"],
"members":{
"UserName":{
"shape":"userNameType",
"documentation":"<p>The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary.</p>"
}
}
},
"DeleteUserPolicyRequest":{
"type":"structure",
"required":[
@ -3814,7 +3914,7 @@
"members":{
"User":{
"shape":"User",
"documentation":"<p>A structure containing details about the IAM user.</p>"
"documentation":"<p>A structure containing details about the IAM user.</p> <important> <p>Due to a service issue, password last used data does not include password use from May 3rd 2018 22:50 PDT to May 23rd 2018 14:08 PDT. This affects <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_finding-unused.html\">last sign-in</a> dates shown in the IAM console and password last used dates in the <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html\">IAM credential report</a>, and returned by this GetUser API. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3rd 2018. For users that signed in after May 23rd 2018 14:08 PDT, the returned password last used date is accurate.</p> <p>If you use password last used information to identify unused credentials for deletion, such as deleting users who did not sign in to AWS in the last 90 days, we recommend that you adjust your evaluation window to include dates after May 23rd 2018. Alternatively, if your users use access keys to access AWS programmatically you can refer to access key last used information because it is accurate for all dates. </p> </important>"
}
},
"documentation":"<p>Contains the response to a successful <a>GetUser</a> request. </p>"
@ -4217,6 +4317,10 @@
"shape":"pathType",
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"PolicyUsageFilter":{
"shape":"PolicyUsageType",
"documentation":"<p>The policy usage method to use for filtering the results.</p> <p>To list only permissions policies, set <code>PolicyUsageFilter</code> to <code>PermissionsPolicy</code>. To list only the policies used to set permissions boundaries, set the value to <code>PermissionsBoundary</code>.</p> <p>This parameter is optional. If it is not included, all policies are returned. </p>"
},
"Marker":{
"shape":"markerType",
"documentation":"<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>"
@ -4502,6 +4606,10 @@
"shape":"policyPathType",
"documentation":"<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.</p>"
},
"PolicyUsageFilter":{
"shape":"PolicyUsageType",
"documentation":"<p>The policy usage method to use for filtering the results.</p> <p>To list only permissions policies, set <code>PolicyUsageFilter</code> to <code>PermissionsPolicy</code>. To list only the policies used to set permissions boundaries, set the value to <code>PermissionsBoundary</code>.</p> <p>This parameter is optional. If it is not included, all policies are returned. </p>"
},
"Marker":{
"shape":"markerType",
"documentation":"<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>"
@ -4987,6 +5095,10 @@
"shape":"attachmentCountType",
"documentation":"<p>The number of principal entities (users, groups, and roles) that the policy is attached to.</p>"
},
"PermissionsBoundaryUsageCount":{
"shape":"attachmentCountType",
"documentation":"<p>The number of entities (users and roles) for which the policy is used as the permissions boundary. </p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>"
},
"IsAttachable":{
"shape":"booleanType",
"documentation":"<p>Specifies whether the policy can be attached to an IAM user, group, or role.</p>"
@ -5114,6 +5226,10 @@
},
"exception":true
},
"PermissionsBoundaryAttachmentType":{
"type":"string",
"enum":["PermissionsBoundaryPolicy"]
},
"Policy":{
"type":"structure",
"members":{
@ -5138,6 +5254,10 @@
"shape":"attachmentCountType",
"documentation":"<p>The number of entities (users, groups, and roles) that the policy is attached to.</p>"
},
"PermissionsBoundaryUsageCount":{
"shape":"attachmentCountType",
"documentation":"<p>The number of entities (users and roles) for which the policy is used to set the permissions boundary. </p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>"
},
"IsAttachable":{
"shape":"booleanType",
"documentation":"<p>Specifies whether the policy can be attached to an IAM user, group, or role.</p>"
@ -5253,6 +5373,14 @@
"none"
]
},
"PolicyUsageType":{
"type":"string",
"documentation":"<p>The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.</p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>",
"enum":[
"PermissionsPolicy",
"PermissionsBoundary"
]
},
"PolicyUser":{
"type":"structure",
"members":{
@ -5329,6 +5457,23 @@
}
}
},
"PutRolePermissionsBoundaryRequest":{
"type":"structure",
"required":[
"RoleName",
"PermissionsBoundary"
],
"members":{
"RoleName":{
"shape":"roleNameType",
"documentation":"<p>The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.</p>"
},
"PermissionsBoundary":{
"shape":"arnType",
"documentation":"<p>The ARN of the policy that is used to set the permissions boundary for the role.</p>"
}
}
},
"PutRolePolicyRequest":{
"type":"structure",
"required":[
@ -5351,6 +5496,23 @@
}
}
},
"PutUserPermissionsBoundaryRequest":{
"type":"structure",
"required":[
"UserName",
"PermissionsBoundary"
],
"members":{
"UserName":{
"shape":"userNameType",
"documentation":"<p>The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.</p>"
},
"PermissionsBoundary":{
"shape":"arnType",
"documentation":"<p>The ARN of the policy that is used to set the permissions boundary for the user.</p>"
}
}
},
"PutUserPolicyRequest":{
"type":"structure",
"required":[
@ -5586,6 +5748,10 @@
"MaxSessionDuration":{
"shape":"roleMaxSessionDurationType",
"documentation":"<p>The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI or API to assume the role can specify the duration using the optional <code>DurationSeconds</code> API parameter or <code>duration-seconds</code> CLI parameter.</p>"
},
"PermissionsBoundary":{
"shape":"AttachedPermissionsBoundary",
"documentation":"<p>The ARN of the policy used to set the permissions boundary for the role.</p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>"
}
},
"documentation":"<p>Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.</p>"
@ -5625,6 +5791,10 @@
"AttachedManagedPolicies":{
"shape":"attachedPoliciesListType",
"documentation":"<p>A list of managed policies attached to the role. These policies are the role's access (permissions) policies.</p>"
},
"PermissionsBoundary":{
"shape":"AttachedPermissionsBoundary",
"documentation":"<p>The ARN of the policy used to set the permissions boundary for the role.</p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>"
}
},
"documentation":"<p>Contains information about an IAM role, including all of the role's policies.</p> <p>This data type is used as a response element in the <a>GetAccountAuthorizationDetails</a> operation.</p>"
@ -5991,7 +6161,7 @@
},
"ResourceOwner":{
"shape":"ResourceNameType",
"documentation":"<p>An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If <code>ResourceOwner</code> is specified, it is also used as the account owner of any <code>ResourcePolicy</code> included in the simulation. If the <code>ResourceOwner</code> parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in <code>CallerArn</code>. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user <code>CallerArn</code>.</p>"
"documentation":"<p>An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If <code>ResourceOwner</code> is specified, it is also used as the account owner of any <code>ResourcePolicy</code> included in the simulation. If the <code>ResourceOwner</code> parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in <code>CallerArn</code>. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user <code>CallerArn</code>.</p> <p>The ARN for an account uses the following syntax: <code>arn:aws:iam::<i>AWS-account-ID</i>:root</code>. For example, to represent the account with the 112233445566 ID, use the following ARN: <code>arn:aws:iam::112233445566-ID:root</code>. </p>"
},
"CallerArn":{
"shape":"ResourceNameType",
@ -6172,7 +6342,7 @@
},
"RequireSymbols":{
"shape":"booleanType",
"documentation":"<p>Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:</p> <p>! @ # $ % ^ &amp;amp; * ( ) _ + - = [ ] { } | '</p> <p>If you do not specify a value for this parameter, then the operation uses the default value of <code>false</code>. The result is that passwords do not require at least one symbol character.</p>"
"documentation":"<p>Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:</p> <p>! @ # $ % ^ &amp; * ( ) _ + - = [ ] { } | '</p> <p>If you do not specify a value for this parameter, then the operation uses the default value of <code>false</code>. The result is that passwords do not require at least one symbol character.</p>"
},
"RequireNumbers":{
"shape":"booleanType",
@ -6463,7 +6633,7 @@
},
"SSHPublicKeyBody":{
"shape":"publicKeyMaterialType",
"documentation":"<p>The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
"documentation":"<p>The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The miminum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> used to validate this parameter is a string of characters consisting of the following:</p> <ul> <li> <p>Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range</p> </li> <li> <p>The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)</p> </li> <li> <p>The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)</p> </li> </ul>"
}
}
},
@ -6575,6 +6745,10 @@
"PasswordLastUsed":{
"shape":"dateType",
"documentation":"<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Credential Reports</a> topic in the <i>Using IAM</i> guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value) then it indicates that they never signed in with a password. This can be because:</p> <ul> <li> <p>The user never had a password.</p> </li> <li> <p>A password exists but has not been used since IAM started tracking this information on October 20th, 2014.</p> </li> </ul> <p>A null does not mean that the user <i>never</i> had a password. Also, if the user does not currently have a password, but had one in the past, then this field contains the date and time the most recent password was used.</p> <p>This value is returned only in the <a>GetUser</a> and <a>ListUsers</a> operations. </p>"
},
"PermissionsBoundary":{
"shape":"AttachedPermissionsBoundary",
"documentation":"<p>The ARN of the policy used to set the permissions boundary for the user.</p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>"
}
},
"documentation":"<p>Contains information about an IAM user entity.</p> <p>This data type is used as a response element in the following operations:</p> <ul> <li> <p> <a>CreateUser</a> </p> </li> <li> <p> <a>GetUser</a> </p> </li> <li> <p> <a>ListUsers</a> </p> </li> </ul>"
@ -6610,6 +6784,10 @@
"AttachedManagedPolicies":{
"shape":"attachedPoliciesListType",
"documentation":"<p>A list of the managed policies attached to the user.</p>"
},
"PermissionsBoundary":{
"shape":"AttachedPermissionsBoundary",
"documentation":"<p>The ARN of the policy used to set the permissions boundary for the user.</p> <p>For more information about permissions boundaries, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html\">Permissions Boundaries for IAM Identities </a> in the <i>IAM User Guide</i>.</p>"
}
},
"documentation":"<p>Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.</p> <p>This data type is used as a response element in the <a>GetAccountAuthorizationDetails</a> operation.</p>"

80
botocore/data/inspector/2016-02-16/service-2.json
View file

@ -24,7 +24,8 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.</p>"
},
@ -42,9 +43,10 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"},
{"shape":"InvalidCrossAccountRoleException"}
{"shape":"InvalidCrossAccountRoleException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Creates a new assessment target using the ARN of the resource group that is generated by <a>CreateResourceGroup</a>. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isn’t already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html\"> Amazon Inspector Assessment Targets</a>.</p>"
"documentation":"<p>Creates a new assessment target using the ARN of the resource group that is generated by <a>CreateResourceGroup</a>. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html\"> Amazon Inspector Assessment Targets</a>.</p>"
},
"CreateAssessmentTemplate":{
"name":"CreateAssessmentTemplate",
@ -59,9 +61,10 @@
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isn’t already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.</p>"
"documentation":"<p>Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.</p>"
},
"CreateExclusionsPreview":{
"name":"CreateExclusionsPreview",
@ -76,7 +79,8 @@
{"shape":"PreviewGenerationInProgressException"},
{"shape":"InternalException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment. </p>"
},
@ -92,7 +96,8 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
{"shape":"AccessDeniedException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see <a>CreateAssessmentTarget</a>.</p>"
},
@ -108,7 +113,8 @@
{"shape":"InvalidInputException"},
{"shape":"AssessmentRunInProgressException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Deletes the assessment run that is specified by the ARN of the assessment run.</p>"
},
@ -124,7 +130,8 @@
{"shape":"InvalidInputException"},
{"shape":"AssessmentRunInProgressException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Deletes the assessment target that is specified by the ARN of the assessment target.</p>"
},
@ -140,7 +147,8 @@
{"shape":"InvalidInputException"},
{"shape":"AssessmentRunInProgressException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Deletes the assessment template that is specified by the ARN of the assessment template.</p>"
},
@ -268,7 +276,8 @@
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"},
{"shape":"AssessmentRunInProgressException"},
{"shape":"UnsupportedFeatureException"}
{"shape":"UnsupportedFeatureException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Produces an assessment report that includes detailed and comprehensive results of a specified assessment run. </p>"
},
@ -474,7 +483,8 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidCrossAccountRoleException"}
{"shape":"InvalidCrossAccountRoleException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.</p>"
},
@ -490,7 +500,8 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.</p>"
},
@ -505,7 +516,8 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.</p>"
},
@ -524,7 +536,8 @@
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"},
{"shape":"InvalidCrossAccountRoleException"},
{"shape":"AgentsAlreadyRunningAssessmentException"}
{"shape":"AgentsAlreadyRunningAssessmentException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.</p>"
},
@ -539,7 +552,8 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Stops the assessment run that is specified by the ARN of the assessment run.</p>"
},
@ -555,7 +569,8 @@
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.</p>"
},
@ -570,7 +585,8 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.</p>"
},
@ -585,9 +601,10 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchEntityException"}
{"shape":"NoSuchEntityException"},
{"shape":"ServiceTemporarilyUnavailableException"}
],
"documentation":"<p>Updates the assessment target that is specified by the ARN of the assessment target.</p>"
"documentation":"<p>Updates the assessment target that is specified by the ARN of the assessment target.</p> <p>If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.</p>"
}
},
"shapes":{
@ -1397,7 +1414,7 @@
},
"resourceGroupArn":{
"shape":"Arn",
"documentation":"<p>The ARN that specifies the resource group that is used to create the assessment target.</p>"
"documentation":"<p>The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.</p>"
}
}
},
@ -1430,7 +1447,7 @@
},
"durationInSeconds":{
"shape":"AssessmentRunDuration",
"documentation":"<p>The duration of the assessment run in seconds. The default value is 3600 seconds (one hour).</p>"
"documentation":"<p>The duration of the assessment run in seconds.</p>"
},
"rulesPackageArns":{
"shape":"AssessmentTemplateRulesPackageArnList",
@ -2988,6 +3005,25 @@
"max":128,
"min":0
},
"ServiceTemporarilyUnavailableException":{
"type":"structure",
"required":[
"message",
"canRetry"
],
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>Details of the exception error.</p>"
},
"canRetry":{
"shape":"Bool",
"documentation":"<p>You can wait and then retry your request.</p>"
}
},
"documentation":"<p>The serice is temporary unavailable.</p>",
"exception":true
},
"SetTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],

2152
botocore/data/iot/2015-05-28/service-2.json
View file

@ -99,6 +99,24 @@
"documentation":"<p>Attaches the specified policy to the specified principal (certificate or other credential).</p> <p> <b>Note:</b> This API is deprecated. Please use <a>AttachPolicy</a> instead.</p>",
"deprecated":true
},
"AttachSecurityProfile":{
"name":"AttachSecurityProfile",
"http":{
"method":"PUT",
"requestUri":"/security-profiles/{securityProfileName}/targets"
},
"input":{"shape":"AttachSecurityProfileRequest"},
"output":{"shape":"AttachSecurityProfileResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"VersionConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Associates a Device Defender security profile with a thing group or with this account. Each thing group or account can have up to five security profiles associated with it.</p>"
},
"AttachThingPrincipal":{
"name":"AttachThingPrincipal",
"http":{
@ -117,6 +135,22 @@
],
"documentation":"<p>Attaches the specified principal to the specified thing.</p>"
},
"CancelAuditTask":{
"name":"CancelAuditTask",
"http":{
"method":"PUT",
"requestUri":"/audit/tasks/{taskId}/cancel"
},
"input":{"shape":"CancelAuditTaskRequest"},
"output":{"shape":"CancelAuditTaskResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an \"InvalidRequestException\" occurs.</p>"
},
"CancelCertificateTransfer":{
"name":"CancelCertificateTransfer",
"http":{
@ -334,6 +368,38 @@
],
"documentation":"<p>Creates a role alias.</p>"
},
"CreateScheduledAudit":{
"name":"CreateScheduledAudit",
"http":{
"method":"POST",
"requestUri":"/audit/scheduledaudits/{scheduledAuditName}"
},
"input":{"shape":"CreateScheduledAuditRequest"},
"output":{"shape":"CreateScheduledAuditResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a scheduled audit that is run at a specified time interval.</p>"
},
"CreateSecurityProfile":{
"name":"CreateSecurityProfile",
"http":{
"method":"POST",
"requestUri":"/security-profiles/{securityProfileName}"
},
"input":{"shape":"CreateSecurityProfileRequest"},
"output":{"shape":"CreateSecurityProfileResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a Device Defender security profile.</p>"
},
"CreateStream":{
"name":"CreateStream",
"http":{
@ -370,7 +436,7 @@
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Creates a thing record in the registry.</p>"
"documentation":"<p>Creates a thing record in the registry.</p> <note> <p>This is a control plane operation. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
},
"CreateThingGroup":{
"name":"CreateThingGroup",
@ -386,7 +452,7 @@
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Create a thing group.</p>"
"documentation":"<p>Create a thing group.</p> <note> <p>This is a control plane operation. See <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorization.html\">Authorization</a> for information about authorizing control plane actions.</p> </note>"
},
"CreateThingType":{
"name":"CreateThingType",
@ -422,6 +488,22 @@
],
"documentation":"<p>Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.</p>"
},
"DeleteAccountAuditConfiguration":{
"name":"DeleteAccountAuditConfiguration",
"http":{
"method":"DELETE",
"requestUri":"/audit/configuration"
},
"input":{"shape":"DeleteAccountAuditConfigurationRequest"},
"output":{"shape":"DeleteAccountAuditConfigurationResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled. </p>"
},
"DeleteAuthorizer":{
"name":"DeleteAuthorizer",
"http":{
@ -602,6 +684,38 @@
],
"documentation":"<p>Deletes a role alias</p>"
},
"DeleteScheduledAudit":{
"name":"DeleteScheduledAudit",
"http":{
"method":"DELETE",
"requestUri":"/audit/scheduledaudits/{scheduledAuditName}"
},
"input":{"shape":"DeleteScheduledAuditRequest"},
"output":{"shape":"DeleteScheduledAuditResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes a scheduled audit.</p>"
},
"DeleteSecurityProfile":{
"name":"DeleteSecurityProfile",
"http":{
"method":"DELETE",
"requestUri":"/security-profiles/{securityProfileName}"
},
"input":{"shape":"DeleteSecurityProfileRequest"},
"output":{"shape":"DeleteSecurityProfileResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"VersionConflictException"}
],
"documentation":"<p>Deletes a Device Defender security profile.</p>"
},
"DeleteStream":{
"name":"DeleteStream",
"http":{
@ -721,6 +835,36 @@
],
"documentation":"<p>Deprecates a thing type. You can not associate new things with deprecated thing type.</p>"
},
"DescribeAccountAuditConfiguration":{
"name":"DescribeAccountAuditConfiguration",
"http":{
"method":"GET",
"requestUri":"/audit/configuration"
},
"input":{"shape":"DescribeAccountAuditConfigurationRequest"},
"output":{"shape":"DescribeAccountAuditConfigurationResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.</p>"
},
"DescribeAuditTask":{
"name":"DescribeAuditTask",
"http":{
"method":"GET",
"requestUri":"/audit/tasks/{taskId}"
},
"input":{"shape":"DescribeAuditTaskRequest"},
"output":{"shape":"DescribeAuditTaskResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Gets information about a Device Defender audit.</p>"
},
"DescribeAuthorizer":{
"name":"DescribeAuthorizer",
"http":{
@ -891,6 +1035,38 @@
],
"documentation":"<p>Describes a role alias.</p>"
},
"DescribeScheduledAudit":{
"name":"DescribeScheduledAudit",
"http":{
"method":"GET",
"requestUri":"/audit/scheduledaudits/{scheduledAuditName}"
},
"input":{"shape":"DescribeScheduledAuditRequest"},
"output":{"shape":"DescribeScheduledAuditResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Gets information about a scheduled audit.</p>"
},
"DescribeSecurityProfile":{
"name":"DescribeSecurityProfile",
"http":{
"method":"GET",
"requestUri":"/security-profiles/{securityProfileName}"
},
"input":{"shape":"DescribeSecurityProfileRequest"},
"output":{"shape":"DescribeSecurityProfileResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Gets information about a Device Defender security profile.</p>"
},
"DescribeStream":{
"name":"DescribeStream",
"http":{
@ -1013,6 +1189,22 @@
"documentation":"<p>Removes the specified policy from the specified certificate.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>DetachPolicy</a> instead.</p>",
"deprecated":true
},
"DetachSecurityProfile":{
"name":"DetachSecurityProfile",
"http":{
"method":"DELETE",
"requestUri":"/security-profiles/{securityProfileName}/targets"
},
"input":{"shape":"DetachSecurityProfileRequest"},
"output":{"shape":"DetachSecurityProfileResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Disassociates a Device Defender security profile from a thing group or from this account.</p>"
},
"DetachThingPrincipal":{
"name":"DetachThingPrincipal",
"http":{
@ -1126,7 +1318,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Gets the logging options.</p>"
"documentation":"<p>Gets the logging options.</p> <p>NOTE: use of this command is not recommended. Use <code>GetV2LoggingOptions</code> instead.</p>"
},
"GetOTAUpdate":{
"name":"GetOTAUpdate",
@ -1225,11 +1417,27 @@
"output":{"shape":"GetV2LoggingOptionsResponse"},
"errors":[
{"shape":"InternalException"},
{"shape":"InvalidRequestException"},
{"shape":"NotConfiguredException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Gets the fine grained logging options.</p>"
},
"ListActiveViolations":{
"name":"ListActiveViolations",
"http":{
"method":"GET",
"requestUri":"/active-violations"
},
"input":{"shape":"ListActiveViolationsRequest"},
"output":{"shape":"ListActiveViolationsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the active violations for a given Device Defender security profile.</p>"
},
"ListAttachedPolicies":{
"name":"ListAttachedPolicies",
"http":{
@ -1249,6 +1457,36 @@
],
"documentation":"<p>Lists the policies attached to the specified thing group.</p>"
},
"ListAuditFindings":{
"name":"ListAuditFindings",
"http":{
"method":"POST",
"requestUri":"/audit/findings"
},
"input":{"shape":"ListAuditFindingsRequest"},
"output":{"shape":"ListAuditFindingsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)</p>"
},
"ListAuditTasks":{
"name":"ListAuditTasks",
"http":{
"method":"GET",
"requestUri":"/audit/tasks"
},
"input":{"shape":"ListAuditTasksRequest"},
"output":{"shape":"ListAuditTasksResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the Device Defender audits that have been performed during a given time period.</p>"
},
"ListAuthorizers":{
"name":"ListAuthorizers",
"http":{
@ -1524,6 +1762,52 @@
],
"documentation":"<p>Lists the role aliases registered in your account.</p>"
},
"ListScheduledAudits":{
"name":"ListScheduledAudits",
"http":{
"method":"GET",
"requestUri":"/audit/scheduledaudits"
},
"input":{"shape":"ListScheduledAuditsRequest"},
"output":{"shape":"ListScheduledAuditsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all of your scheduled audits.</p>"
},
"ListSecurityProfiles":{
"name":"ListSecurityProfiles",
"http":{
"method":"GET",
"requestUri":"/security-profiles"
},
"input":{"shape":"ListSecurityProfilesRequest"},
"output":{"shape":"ListSecurityProfilesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>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.</p>"
},
"ListSecurityProfilesForTarget":{
"name":"ListSecurityProfilesForTarget",
"http":{
"method":"GET",
"requestUri":"/security-profiles-for-target"
},
"input":{"shape":"ListSecurityProfilesForTargetRequest"},
"output":{"shape":"ListSecurityProfilesForTargetResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists the Device Defender security profiles attached to a target (thing group).</p>"
},
"ListStreams":{
"name":"ListStreams",
"http":{
@ -1560,6 +1844,22 @@
],
"documentation":"<p>List targets for the specified policy.</p>"
},
"ListTargetsForSecurityProfile":{
"name":"ListTargetsForSecurityProfile",
"http":{
"method":"GET",
"requestUri":"/security-profiles/{securityProfileName}/targets"
},
"input":{"shape":"ListTargetsForSecurityProfileRequest"},
"output":{"shape":"ListTargetsForSecurityProfileResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the targets (thing groups) associated with a given Device Defender security profile.</p>"
},
"ListThingGroups":{
"name":"ListThingGroups",
"http":{
@ -1720,6 +2020,21 @@
],
"documentation":"<p>Lists logging levels.</p>"
},
"ListViolationEvents":{
"name":"ListViolationEvents",
"http":{
"method":"GET",
"requestUri":"/violation-events"
},
"input":{"shape":"ListViolationEventsRequest"},
"output":{"shape":"ListViolationEventsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior or thing (device).</p>"
},
"RegisterCACertificate":{
"name":"RegisterCACertificate",
"http":{
@ -1899,7 +2214,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Sets the logging options.</p>"
"documentation":"<p>Sets the logging options.</p> <p>NOTE: use of this command is not recommended. Use <code>SetV2LoggingOptions</code> instead.</p>"
},
"SetV2LoggingLevel":{
"name":"SetV2LoggingLevel",
@ -1930,6 +2245,22 @@
],
"documentation":"<p>Sets the logging options for the V2 logging service.</p>"
},
"StartOnDemandAuditTask":{
"name":"StartOnDemandAuditTask",
"http":{
"method":"POST",
"requestUri":"/audit/tasks"
},
"input":{"shape":"StartOnDemandAuditTaskRequest"},
"output":{"shape":"StartOnDemandAuditTaskResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Starts an on-demand Device Defender audit.</p>"
},
"StartThingRegistrationTask":{
"name":"StartThingRegistrationTask",
"http":{
@ -2021,6 +2352,21 @@
],
"documentation":"<p>Transfers the specified certificate to the specified AWS account.</p> <p>You can cancel the transfer until it is acknowledged by the recipient.</p> <p>No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.</p> <p>The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.</p> <p>The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.</p>"
},
"UpdateAccountAuditConfiguration":{
"name":"UpdateAccountAuditConfiguration",
"http":{
"method":"PATCH",
"requestUri":"/audit/configuration"
},
"input":{"shape":"UpdateAccountAuditConfigurationRequest"},
"output":{"shape":"UpdateAccountAuditConfigurationResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.</p>"
},
"UpdateAuthorizer":{
"name":"UpdateAuthorizer",
"http":{
@ -2125,6 +2471,39 @@
],
"documentation":"<p>Updates a role alias.</p>"
},
"UpdateScheduledAudit":{
"name":"UpdateScheduledAudit",
"http":{
"method":"PATCH",
"requestUri":"/audit/scheduledaudits/{scheduledAuditName}"
},
"input":{"shape":"UpdateScheduledAuditRequest"},
"output":{"shape":"UpdateScheduledAuditResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates a scheduled audit, including what checks are performed and how often the audit takes place.</p>"
},
"UpdateSecurityProfile":{
"name":"UpdateSecurityProfile",
"http":{
"method":"PATCH",
"requestUri":"/security-profiles/{securityProfileName}"
},
"input":{"shape":"UpdateSecurityProfileRequest"},
"output":{"shape":"UpdateSecurityProfileResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"VersionConflictException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates a Device Defender security profile.</p>"
},
"UpdateStream":{
"name":"UpdateStream",
"http":{
@ -2194,6 +2573,21 @@
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the groups to which the thing belongs.</p>"
},
"ValidateSecurityProfileBehaviors":{
"name":"ValidateSecurityProfileBehaviors",
"http":{
"method":"POST",
"requestUri":"/security-profile-behaviors/validate"
},
"input":{"shape":"ValidateSecurityProfileBehaviorsRequest"},
"output":{"shape":"ValidateSecurityProfileBehaviorsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Validates a Device Defender security profile behaviors specification.</p>"
}
},
"shapes":{
@ -2274,6 +2668,10 @@
"iotAnalytics":{
"shape":"IotAnalyticsAction",
"documentation":"<p>Sends message data to an AWS IoT Analytics channel.</p>"
},
"stepFunctions":{
"shape":"StepFunctionsAction",
"documentation":"<p>Starts execution of a Step Functions state machine.</p>"
}
},
"documentation":"<p>Describes the actions associated with a rule.</p>"
@ -2293,6 +2691,44 @@
"CONNECT"
]
},
"ActiveViolation":{
"type":"structure",
"members":{
"violationId":{
"shape":"ViolationId",
"documentation":"<p>The ID of the active violation.</p>"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing responsible for the active violation.</p>"
},
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The security profile whose behavior is in violation.</p>"
},
"behavior":{
"shape":"Behavior",
"documentation":"<p>The behavior which is being violated.</p>"
},
"lastViolationValue":{
"shape":"MetricValue",
"documentation":"<p>The value of the metric (the measurement) which caused the most recent violation.</p>"
},
"lastViolationTime":{
"shape":"Timestamp",
"documentation":"<p>The time the most recent violation occurred.</p>"
},
"violationStartTime":{
"shape":"Timestamp",
"documentation":"<p>The time the violation started.</p>"
}
},
"documentation":"<p>Information about an active Device Defender security profile behavior violation.</p>"
},
"ActiveViolations":{
"type":"list",
"member":{"shape":"ActiveViolation"}
},
"AddThingToThingGroupRequest":{
"type":"structure",
"members":{
@ -2325,6 +2761,35 @@
"value":{"shape":"Value"}
},
"AlarmName":{"type":"string"},
"AlertTarget":{
"type":"structure",
"required":[
"alertTargetArn",
"roleArn"
],
"members":{
"alertTargetArn":{
"shape":"AlertTargetArn",
"documentation":"<p>The ARN of the notification target to which alerts are sent.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The ARN of the role that grants permission to send alerts to the notification target.</p>"
}
},
"documentation":"<p>A structure containing the alert target ARN and the role ARN.</p>"
},
"AlertTargetArn":{"type":"string"},
"AlertTargetType":{
"type":"string",
"documentation":"<p>The type of alert target: one of \"SNS\".</p>",
"enum":["SNS"]
},
"AlertTargets":{
"type":"map",
"key":{"shape":"AlertTargetType"},
"value":{"shape":"AlertTarget"}
},
"AllowAutoRegistration":{"type":"boolean"},
"Allowed":{
"type":"structure",
@ -2418,6 +2883,32 @@
},
"documentation":"<p>The input for the AttachPrincipalPolicy operation.</p>"
},
"AttachSecurityProfileRequest":{
"type":"structure",
"required":[
"securityProfileName",
"securityProfileTargetArn"
],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The security profile that is attached.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"securityProfileTargetArn":{
"shape":"SecurityProfileTargetArn",
"documentation":"<p>The ARN of the target (thing group) to which the security profile is attached.</p>",
"location":"querystring",
"locationName":"securityProfileTargetArn"
}
}
},
"AttachSecurityProfileResponse":{
"type":"structure",
"members":{
}
},
"AttachThingPrincipalRequest":{
"type":"structure",
"required":[
@ -2480,6 +2971,206 @@
"key":{"shape":"Key"},
"value":{"shape":"Value"}
},
"AuditCheckConfiguration":{
"type":"structure",
"members":{
"enabled":{
"shape":"Enabled",
"documentation":"<p>True if this audit check is enabled for this account.</p>"
}
},
"documentation":"<p>Which audit checks are enabled and disabled for this account.</p>"
},
"AuditCheckConfigurations":{
"type":"map",
"key":{"shape":"AuditCheckName"},
"value":{"shape":"AuditCheckConfiguration"}
},
"AuditCheckDetails":{
"type":"structure",
"members":{
"checkRunStatus":{
"shape":"AuditCheckRunStatus",
"documentation":"<p>The completion status of this check, one of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\", \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".</p>"
},
"checkCompliant":{
"shape":"CheckCompliant",
"documentation":"<p>True if the check completed and found all resources compliant.</p>"
},
"totalResourcesCount":{
"shape":"TotalResourcesCount",
"documentation":"<p>The number of resources on which the check was performed.</p>"
},
"nonCompliantResourcesCount":{
"shape":"NonCompliantResourcesCount",
"documentation":"<p>The number of resources that the check found non-compliant.</p>"
},
"errorCode":{
"shape":"ErrorCode",
"documentation":"<p>The code of any error encountered when performing this check during this audit. One of \"INSUFFICIENT_PERMISSIONS\", or \"AUDIT_CHECK_DISABLED\".</p>"
},
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The message associated with any error encountered when performing this check during this audit.</p>"
}
},
"documentation":"<p>Information about the audit check.</p>"
},
"AuditCheckName":{
"type":"string",
"documentation":"<p>An audit check name. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"AuditCheckRunStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"WAITING_FOR_DATA_COLLECTION",
"CANCELED",
"COMPLETED_COMPLIANT",
"COMPLETED_NON_COMPLIANT",
"FAILED"
]
},
"AuditDetails":{
"type":"map",
"key":{"shape":"AuditCheckName"},
"value":{"shape":"AuditCheckDetails"}
},
"AuditFinding":{
"type":"structure",
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of the audit that generated this result (finding)</p>"
},
"checkName":{
"shape":"AuditCheckName",
"documentation":"<p>The audit check that generated this result.</p>"
},
"taskStartTime":{
"shape":"Timestamp",
"documentation":"<p>The time the audit started.</p>"
},
"findingTime":{
"shape":"Timestamp",
"documentation":"<p>The time the result (finding) was discovered.</p>"
},
"severity":{
"shape":"AuditFindingSeverity",
"documentation":"<p>The severity of the result (finding).</p>"
},
"nonCompliantResource":{
"shape":"NonCompliantResource",
"documentation":"<p>The resource that was found to be non-compliant with the audit check.</p>"
},
"relatedResources":{
"shape":"RelatedResources",
"documentation":"<p>The list of related resources.</p>"
},
"reasonForNonCompliance":{
"shape":"ReasonForNonCompliance",
"documentation":"<p>The reason the resource was non-compliant.</p>"
},
"reasonForNonComplianceCode":{
"shape":"ReasonForNonComplianceCode",
"documentation":"<p>A code which indicates the reason that the resource was non-compliant.</p>"
}
},
"documentation":"<p>The findings (results) of the audit.</p>"
},
"AuditFindingSeverity":{
"type":"string",
"enum":[
"CRITICAL",
"HIGH",
"MEDIUM",
"LOW"
]
},
"AuditFindings":{
"type":"list",
"member":{"shape":"AuditFinding"}
},
"AuditFrequency":{
"type":"string",
"enum":[
"DAILY",
"WEEKLY",
"BIWEEKLY",
"MONTHLY"
]
},
"AuditNotificationTarget":{
"type":"structure",
"members":{
"targetArn":{
"shape":"TargetArn",
"documentation":"<p>The ARN of the target (SNS topic) to which audit notifications are sent.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The ARN of the role that grants permission to send notifications to the target.</p>"
},
"enabled":{
"shape":"Enabled",
"documentation":"<p>True if notifications to the target are enabled.</p>"
}
},
"documentation":"<p>Information about the targets to which audit notifications are sent.</p>"
},
"AuditNotificationTargetConfigurations":{
"type":"map",
"key":{"shape":"AuditNotificationType"},
"value":{"shape":"AuditNotificationTarget"}
},
"AuditNotificationType":{
"type":"string",
"enum":["SNS"]
},
"AuditTaskId":{
"type":"string",
"max":40,
"min":1,
"pattern":"[a-zA-Z0-9\\-]+"
},
"AuditTaskMetadata":{
"type":"structure",
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of this audit.</p>"
},
"taskStatus":{
"shape":"AuditTaskStatus",
"documentation":"<p>The status of this audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".</p>"
},
"taskType":{
"shape":"AuditTaskType",
"documentation":"<p>The type of this audit: one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".</p>"
}
},
"documentation":"<p>The audits that were performed.</p>"
},
"AuditTaskMetadataList":{
"type":"list",
"member":{"shape":"AuditTaskMetadata"}
},
"AuditTaskStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"COMPLETED",
"FAILED",
"CANCELED"
]
},
"AuditTaskType":{
"type":"string",
"enum":[
"ON_DEMAND_AUDIT_TASK",
"SCHEDULED_AUDIT_TASK"
]
},
"AuthDecision":{
"type":"string",
"enum":[
@ -2618,12 +3309,63 @@
},
"AwsAccountId":{
"type":"string",
"pattern":"[0-9]{12}"
"max":12,
"min":12,
"pattern":"[0-9]+"
},
"AwsArn":{"type":"string"},
"AwsIotJobArn":{"type":"string"},
"AwsIotJobId":{"type":"string"},
"AwsIotSqlVersion":{"type":"string"},
"Behavior":{
"type":"structure",
"required":["name"],
"members":{
"name":{
"shape":"BehaviorName",
"documentation":"<p>The name you have given to the behavior.</p>"
},
"metric":{
"shape":"BehaviorMetric",
"documentation":"<p>What is measured by the behavior.</p>"
},
"criteria":{
"shape":"BehaviorCriteria",
"documentation":"<p>The criteria that determine if a device is behaving normally in regard to the <code>metric</code>.</p>"
}
},
"documentation":"<p>A Device Defender security profile behavior.</p>"
},
"BehaviorCriteria":{
"type":"structure",
"members":{
"comparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"<p>The operator that relates the thing measured (<code>metric</code>) to the criteria (<code>value</code>).</p>"
},
"value":{
"shape":"MetricValue",
"documentation":"<p>The value to be compared with the <code>metric</code>.</p>"
},
"durationSeconds":{
"shape":"DurationSeconds",
"documentation":"<p>Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, <code>NUM_MESSAGES_SENT</code>).</p>"
}
},
"documentation":"<p>The criteria by which the behavior is determined to be normal.</p>"
},
"BehaviorMetric":{"type":"string"},
"BehaviorName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9:_-]+"
},
"Behaviors":{
"type":"list",
"member":{"shape":"Behavior"},
"max":100
},
"Boolean":{"type":"boolean"},
"BucketName":{"type":"string"},
"CACertificate":{
@ -2690,6 +3432,10 @@
"generationId":{
"shape":"GenerationId",
"documentation":"<p>The generation ID of the CA certificate.</p>"
},
"validity":{
"shape":"CertificateValidity",
"documentation":"<p>When the CA certificate is valid.</p>"
}
},
"documentation":"<p>Describes a CA certificate.</p>"
@ -2705,6 +3451,23 @@
"type":"list",
"member":{"shape":"CACertificate"}
},
"CancelAuditTaskRequest":{
"type":"structure",
"required":["taskId"],
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of the audit you want to cancel. You can only cancel an audit that is \"IN_PROGRESS\".</p>",
"location":"uri",
"locationName":"taskId"
}
}
},
"CancelAuditTaskResponse":{
"type":"structure",
"members":{
}
},
"CancelCertificateTransferRequest":{
"type":"structure",
"required":["certificateId"],
@ -2792,6 +3555,7 @@
}
}
},
"CanceledChecksCount":{"type":"integer"},
"CanceledThings":{"type":"integer"},
"CannedAccessControlList":{
"type":"string",
@ -2891,6 +3655,10 @@
"generationId":{
"shape":"GenerationId",
"documentation":"<p>The generation ID of the certificate.</p>"
},
"validity":{
"shape":"CertificateValidity",
"documentation":"<p>When the certificate is valid.</p>"
}
},
"documentation":"<p>Describes a certificate.</p>"
@ -2947,11 +3715,36 @@
"error":{"httpStatusCode":400},
"exception":true
},
"CertificateValidity":{
"type":"structure",
"members":{
"notBefore":{
"shape":"DateType",
"documentation":"<p>The certificate is not valid before this date.</p>"
},
"notAfter":{
"shape":"DateType",
"documentation":"<p>The certificate is not valid after this date.</p>"
}
},
"documentation":"<p>When the certificate is valid.</p>"
},
"Certificates":{
"type":"list",
"member":{"shape":"Certificate"}
},
"ChannelName":{"type":"string"},
"CheckCompliant":{"type":"boolean"},
"Cidr":{
"type":"string",
"max":43,
"min":2,
"pattern":"[a-fA-F0-9:\\.\\/]+"
},
"Cidrs":{
"type":"list",
"member":{"shape":"Cidr"}
},
"ClearDefaultAuthorizerRequest":{
"type":"structure",
"members":{
@ -3006,23 +3799,23 @@
"documentation":"<p>The IAM role that allows access to the CloudWatch metric.</p>"
},
"metricNamespace":{
"shape":"MetricNamespace",
"shape":"String",
"documentation":"<p>The CloudWatch metric namespace name.</p>"
},
"metricName":{
"shape":"MetricName",
"shape":"String",
"documentation":"<p>The CloudWatch metric name.</p>"
},
"metricValue":{
"shape":"MetricValue",
"shape":"String",
"documentation":"<p>The CloudWatch metric value.</p>"
},
"metricUnit":{
"shape":"MetricUnit",
"shape":"String",
"documentation":"<p>The <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit\">metric unit</a> supported by CloudWatch.</p>"
},
"metricTimestamp":{
"shape":"MetricTimestamp",
"shape":"String",
"documentation":"<p>An optional <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp\">Unix timestamp</a>.</p>"
}
},
@ -3081,6 +3874,20 @@
"max":2028,
"pattern":"[^\\p{C}]+"
},
"ComparisonOperator":{
"type":"string",
"enum":[
"less-than",
"less-than-equals",
"greater-than",
"greater-than-equals",
"in-cidr-set",
"not-in-cidr-set",
"in-port-set",
"not-in-port-set"
]
},
"CompliantChecksCount":{"type":"integer"},
"Configuration":{
"type":"structure",
"members":{
@ -3094,7 +3901,10 @@
"ConflictingResourceUpdateException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
"message":{
"shape":"errorMessage",
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.</p>",
"error":{"httpStatusCode":409},
@ -3222,10 +4032,6 @@
"jobExecutionsRolloutConfig":{
"shape":"JobExecutionsRolloutConfig",
"documentation":"<p>Allows you to create a staged rollout of the job.</p>"
},
"documentParameters":{
"shape":"JobDocumentParameters",
"documentation":"<p>Parameters for the job document.</p>"
}
}
},
@ -3472,6 +4278,87 @@
}
}
},
"CreateScheduledAuditRequest":{
"type":"structure",
"required":[
"frequency",
"targetCheckNames",
"scheduledAuditName"
],
"members":{
"frequency":{
"shape":"AuditFrequency",
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit takes place. Can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
},
"targetCheckNames":{
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"CreateScheduledAuditResponse":{
"type":"structure",
"members":{
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
}
}
},
"CreateSecurityProfileRequest":{
"type":"structure",
"required":[
"securityProfileName",
"behaviors"
],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name you are giving to the security profile.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>A description of the security profile.</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.</p>"
}
}
},
"CreateSecurityProfileResponse":{
"type":"structure",
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name you gave to the security profile.</p>"
},
"securityProfileArn":{
"shape":"SecurityProfileArn",
"documentation":"<p>The ARN of the security profile.</p>"
}
}
},
"CreateStreamRequest":{
"type":"structure",
"required":[
@ -3687,6 +4574,38 @@
"min":1
},
"DateType":{"type":"timestamp"},
"DayOfMonth":{
"type":"string",
"pattern":"^([1-9]|[12][0-9]|3[01])$|^LAST$"
},
"DayOfWeek":{
"type":"string",
"enum":[
"SUN",
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
]
},
"DeleteAccountAuditConfigurationRequest":{
"type":"structure",
"members":{
"deleteScheduledAudits":{
"shape":"DeleteScheduledAudits",
"documentation":"<p>If true, all scheduled audits are deleted.</p>",
"location":"querystring",
"locationName":"deleteScheduledAudits"
}
}
},
"DeleteAccountAuditConfigurationResponse":{
"type":"structure",
"members":{
}
},
"DeleteAuthorizerRequest":{
"type":"structure",
"required":["authorizerName"],
@ -3887,6 +4806,47 @@
"members":{
}
},
"DeleteScheduledAuditRequest":{
"type":"structure",
"required":["scheduledAuditName"],
"members":{
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit you want to delete.</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"DeleteScheduledAuditResponse":{
"type":"structure",
"members":{
}
},
"DeleteScheduledAudits":{"type":"boolean"},
"DeleteSecurityProfileRequest":{
"type":"structure",
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile to be deleted.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"expectedVersion":{
"shape":"OptionalVersion",
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a <code>VersionConflictException</code> is thrown.</p>",
"location":"querystring",
"locationName":"expectedVersion"
}
}
},
"DeleteSecurityProfileResponse":{
"type":"structure",
"members":{
}
},
"DeleteStreamRequest":{
"type":"structure",
"required":["streamId"],
@ -4044,6 +5004,69 @@
"documentation":"<p>The output for the DeprecateThingType operation.</p>"
},
"DeprecationDate":{"type":"timestamp"},
"DescribeAccountAuditConfigurationRequest":{
"type":"structure",
"members":{
}
},
"DescribeAccountAuditConfigurationResponse":{
"type":"structure",
"members":{
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code> this parameter is required.</p>"
},
"auditNotificationTargetConfigurations":{
"shape":"AuditNotificationTargetConfigurations",
"documentation":"<p>Information about the targets to which audit notifications are sent for this account.</p>"
},
"auditCheckConfigurations":{
"shape":"AuditCheckConfigurations",
"documentation":"<p>Which audit checks are enabled and disabled for this account.</p>"
}
}
},
"DescribeAuditTaskRequest":{
"type":"structure",
"required":["taskId"],
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of the audit whose information you want to get.</p>",
"location":"uri",
"locationName":"taskId"
}
}
},
"DescribeAuditTaskResponse":{
"type":"structure",
"members":{
"taskStatus":{
"shape":"AuditTaskStatus",
"documentation":"<p>The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".</p>"
},
"taskType":{
"shape":"AuditTaskType",
"documentation":"<p>The type of audit: \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".</p>"
},
"taskStartTime":{
"shape":"Timestamp",
"documentation":"<p>The time the audit started.</p>"
},
"taskStatistics":{
"shape":"TaskStatistics",
"documentation":"<p>Statistical information about the audit.</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit (only if the audit was a scheduled audit).</p>"
},
"auditDetails":{
"shape":"AuditDetails",
"documentation":"<p>Detailed information about each check performed during this audit.</p>"
}
}
},
"DescribeAuthorizerRequest":{
"type":"structure",
"required":["authorizerName"],
@ -4284,6 +5307,96 @@
}
}
},
"DescribeScheduledAuditRequest":{
"type":"structure",
"required":["scheduledAuditName"],
"members":{
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit whose information you want to get.</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"DescribeScheduledAuditResponse":{
"type":"structure",
"members":{
"frequency":{
"shape":"AuditFrequency",
"documentation":"<p>How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit takes place. Will be \"1\" through \"31\" or \"LAST\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit takes place. One of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\".</p>"
},
"targetCheckNames":{
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the scheduled audit. (Note that checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit.</p>"
},
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
}
}
},
"DescribeSecurityProfileRequest":{
"type":"structure",
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile whose information you want to get.</p>",
"location":"uri",
"locationName":"securityProfileName"
}
}
},
"DescribeSecurityProfileResponse":{
"type":"structure",
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile.</p>"
},
"securityProfileArn":{
"shape":"SecurityProfileArn",
"documentation":"<p>The ARN of the security profile.</p>"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>A description of the security profile (associated with the security profile when it was created or updated).</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>The version of the security profile. A new version is generated whenever the security profile is updated.</p>"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was created.</p>"
},
"lastModifiedDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was last modified.</p>"
}
}
},
"DescribeStreamRequest":{
"type":"structure",
"required":["streamId"],
@ -4539,6 +5652,32 @@
},
"documentation":"<p>The input for the DetachPrincipalPolicy operation.</p>"
},
"DetachSecurityProfileRequest":{
"type":"structure",
"required":[
"securityProfileName",
"securityProfileTargetArn"
],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The security profile that is detached.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"securityProfileTargetArn":{
"shape":"SecurityProfileTargetArn",
"documentation":"<p>The ARN of the thing group from which the security profile is detached.</p>",
"location":"querystring",
"locationName":"securityProfileTargetArn"
}
}
},
"DetachSecurityProfileResponse":{
"type":"structure",
"members":{
}
},
"DetachThingPrincipalRequest":{
"type":"structure",
"required":[
@ -4598,6 +5737,7 @@
},
"documentation":"<p>The input for the DisableTopicRuleRequest operation.</p>"
},
"DurationSeconds":{"type":"integer"},
"DynamoDBAction":{
"type":"structure",
"required":[
@ -4750,6 +5890,7 @@
"Enabled":{"type":"boolean"},
"EndpointAddress":{"type":"string"},
"EndpointType":{"type":"string"},
"ErrorCode":{"type":"string"},
"ErrorInfo":{
"type":"structure",
"members":{
@ -4783,9 +5924,13 @@
"THING_GROUP_HIERARCHY",
"THING_TYPE_ASSOCIATION",
"JOB",
"JOB_EXECUTION"
"JOB_EXECUTION",
"POLICY",
"CERTIFICATE",
"CA_CERTIFICATE"
]
},
"ExecutionNamePrefix":{"type":"string"},
"ExecutionNumber":{"type":"long"},
"ExpectedVersion":{"type":"long"},
"ExpiresInSec":{
@ -4803,6 +5948,7 @@
},
"documentation":"<p>Information that explicitly denies authorization.</p>"
},
"FailedChecksCount":{"type":"integer"},
"FailedThings":{"type":"integer"},
"FileId":{
"type":"integer",
@ -5150,6 +6296,7 @@
},
"documentation":"<p>Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.</p>"
},
"InProgressChecksCount":{"type":"integer"},
"InProgressThings":{"type":"integer"},
"IndexName":{
"type":"string",
@ -5164,7 +6311,10 @@
"IndexNotReadyException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
"message":{
"shape":"errorMessage",
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>The index is not ready.</p>",
"error":{"httpStatusCode":400},
@ -5209,7 +6359,10 @@
"InvalidQueryException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
"message":{
"shape":"errorMessage",
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>The query is invalid.</p>",
"error":{"httpStatusCode":400},
@ -5230,7 +6383,10 @@
"InvalidResponseException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
"message":{
"shape":"errorMessage",
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>The response is invalid.</p>",
"error":{"httpStatusCode":400},
@ -5239,7 +6395,10 @@
"InvalidStateTransitionException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
"message":{
"shape":"errorMessage",
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is \"IN_PROGRESS\" without setting the <code>force</code> parameter.</p>",
"error":{"httpStatusCode":409},
@ -5324,10 +6483,6 @@
"jobProcessDetails":{
"shape":"JobProcessDetails",
"documentation":"<p>Details about the job process.</p>"
},
"documentParameters":{
"shape":"JobDocumentParameters",
"documentation":"<p>The parameters specified for the job document.</p>"
}
},
"documentation":"<p>The <code>Job</code> object contains details about a job.</p>"
@ -5342,12 +6497,6 @@
"type":"string",
"max":32768
},
"JobDocumentParameters":{
"type":"map",
"key":{"shape":"ParameterKey"},
"value":{"shape":"ParameterValue"},
"max":10
},
"JobDocumentSource":{
"type":"string",
"max":1350,
@ -5670,6 +6819,48 @@
"error":{"httpStatusCode":410},
"exception":true
},
"ListActiveViolationsRequest":{
"type":"structure",
"members":{
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing whose active violations are listed.</p>",
"location":"querystring",
"locationName":"thingName"
},
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the Device Defender security profile for which violations are listed.</p>",
"location":"querystring",
"locationName":"securityProfileName"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListActiveViolationsResponse":{
"type":"structure",
"members":{
"activeViolations":{
"shape":"ActiveViolations",
"documentation":"<p>The list of active violations.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListAttachedPoliciesRequest":{
"type":"structure",
"required":["target"],
@ -5713,6 +6904,110 @@
}
}
},
"ListAuditFindingsRequest":{
"type":"structure",
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.</p>"
},
"checkName":{
"shape":"AuditCheckName",
"documentation":"<p>A filter to limit results to the findings for the specified audit check.</p>"
},
"resourceIdentifier":{
"shape":"ResourceIdentifier",
"documentation":"<p>Information identifying the non-compliant resource.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>"
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.</p>"
}
}
},
"ListAuditFindingsResponse":{
"type":"structure",
"members":{
"findings":{
"shape":"AuditFindings",
"documentation":"<p>The findings (results) of the audit.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListAuditTasksRequest":{
"type":"structure",
"required":[
"startTime",
"endTime"
],
"members":{
"startTime":{
"shape":"Timestamp",
"documentation":"<p>The beginning of the time period. Note that audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an \"InvalidRequestException\".</p>",
"location":"querystring",
"locationName":"startTime"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>The end of the time period.</p>",
"location":"querystring",
"locationName":"endTime"
},
"taskType":{
"shape":"AuditTaskType",
"documentation":"<p>A filter to limit the output to the specified type of audit: can be one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".</p>",
"location":"querystring",
"locationName":"taskType"
},
"taskStatus":{
"shape":"AuditTaskStatus",
"documentation":"<p>A filter to limit the output to audits with the specified completion status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\" or \"CANCELED\".</p>",
"location":"querystring",
"locationName":"taskStatus"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListAuditTasksResponse":{
"type":"structure",
"members":{
"tasks":{
"shape":"AuditTaskMetadataList",
"documentation":"<p>The audits that were performed during the specified time period.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListAuthorizersRequest":{
"type":"structure",
"members":{
@ -6277,7 +7572,7 @@
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -6346,6 +7641,109 @@
}
}
},
"ListScheduledAuditsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time. The default is 25.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListScheduledAuditsResponse":{
"type":"structure",
"members":{
"scheduledAudits":{
"shape":"ScheduledAuditMetadataList",
"documentation":"<p>The list of scheduled audits.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListSecurityProfilesForTargetRequest":{
"type":"structure",
"required":["securityProfileTargetArn"],
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"recursive":{
"shape":"Recursive",
"documentation":"<p>If true, return child groups as well.</p>",
"location":"querystring",
"locationName":"recursive"
},
"securityProfileTargetArn":{
"shape":"SecurityProfileTargetArn",
"documentation":"<p>The ARN of the target (thing group) whose attached security profiles you want to get.</p>",
"location":"querystring",
"locationName":"securityProfileTargetArn"
}
}
},
"ListSecurityProfilesForTargetResponse":{
"type":"structure",
"members":{
"securityProfileTargetMappings":{
"shape":"SecurityProfileTargetMappings",
"documentation":"<p>A list of security profiles and their associated targets.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListSecurityProfilesRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListSecurityProfilesResponse":{
"type":"structure",
"members":{
"securityProfileIdentifiers":{
"shape":"SecurityProfileIdentifiers",
"documentation":"<p>A list of security profile identifiers (names and ARNs).</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListStreamsRequest":{
"type":"structure",
"members":{
@ -6419,6 +7817,43 @@
}
}
},
"ListTargetsForSecurityProfileRequest":{
"type":"structure",
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The security profile.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListTargetsForSecurityProfileResponse":{
"type":"structure",
"members":{
"securityProfileTargets":{
"shape":"SecurityProfileTargets",
"documentation":"<p>The thing groups to which the security profile is attached.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"ListThingGroupsForThingRequest":{
"type":"structure",
"required":["thingName"],
@ -6431,7 +7866,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -6461,7 +7896,7 @@
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -6573,7 +8008,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to retrieve the next set of results.</p>"
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>"
}
}
},
@ -6582,7 +8017,7 @@
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -6618,7 +8053,7 @@
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -6669,7 +8104,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -6699,7 +8134,7 @@
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"documentation":"<p>The token to retrieve the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
@ -6824,6 +8259,64 @@
}
}
},
"ListViolationEventsRequest":{
"type":"structure",
"required":[
"startTime",
"endTime"
],
"members":{
"startTime":{
"shape":"Timestamp",
"documentation":"<p>The start time for the alerts to be listed.</p>",
"location":"querystring",
"locationName":"startTime"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>The end time for the alerts to be listed.</p>",
"location":"querystring",
"locationName":"endTime"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>A filter to limit results to those alerts caused by the specified thing.</p>",
"location":"querystring",
"locationName":"thingName"
},
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>A filter to limit results to those alerts generated by the specified security profile.</p>",
"location":"querystring",
"locationName":"securityProfileName"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListViolationEventsResponse":{
"type":"structure",
"members":{
"violationEvents":{
"shape":"ViolationEvents",
"documentation":"<p>The security profile violation alerts issued for this account during the given time frame, potentially filtered by security profile, behavior violated, or thing (device) violating.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
}
}
},
"LogLevel":{
"type":"string",
"enum":[
@ -6927,21 +8420,57 @@
"JSON"
]
},
"MetricName":{"type":"string"},
"MetricNamespace":{"type":"string"},
"MetricTimestamp":{"type":"string"},
"MetricUnit":{"type":"string"},
"MetricValue":{"type":"string"},
"MetricValue":{
"type":"structure",
"members":{
"count":{
"shape":"UnsignedLong",
"documentation":"<p>If the <code>comparisonOperator</code> calls for a numeric value, use this to specify that numeric value to be compared with the <code>metric</code>.</p>"
},
"cidrs":{
"shape":"Cidrs",
"documentation":"<p>If the <code>comparisonOperator</code> calls for a set of CIDRs, use this to specify that set to be compared with the <code>metric</code>.</p>"
},
"ports":{
"shape":"Ports",
"documentation":"<p>If the <code>comparisonOperator</code> calls for a set of ports, use this to specify that set to be compared with the <code>metric</code>.</p>"
}
},
"documentation":"<p>The value to be compared with the <code>metric</code>.</p>"
},
"MissingContextValue":{"type":"string"},
"MissingContextValues":{
"type":"list",
"member":{"shape":"MissingContextValue"}
},
"NextToken":{"type":"string"},
"NonCompliantChecksCount":{"type":"integer"},
"NonCompliantResource":{
"type":"structure",
"members":{
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the non-compliant resource.</p>"
},
"resourceIdentifier":{
"shape":"ResourceIdentifier",
"documentation":"<p>Information identifying the non-compliant resource.</p>"
},
"additionalInfo":{
"shape":"StringMap",
"documentation":"<p>Additional information about the non-compliant resource.</p>"
}
},
"documentation":"<p>Information about the resource that was non-compliant with the audit check.</p>"
},
"NonCompliantResourcesCount":{"type":"long"},
"NotConfiguredException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
"message":{
"shape":"errorMessage",
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>The resource is not configured.</p>",
"error":{"httpStatusCode":404},
@ -7123,18 +8652,6 @@
"min":1
},
"Parameter":{"type":"string"},
"ParameterKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9:_-]+"
},
"ParameterValue":{
"type":"string",
"max":1024,
"min":1,
"pattern":"[^\\p{C}]+"
},
"Parameters":{
"type":"map",
"key":{"shape":"Parameter"},
@ -7208,10 +8725,33 @@
"type":"string",
"pattern":"[0-9]+"
},
"PolicyVersionIdentifier":{
"type":"structure",
"members":{
"policyName":{
"shape":"PolicyName",
"documentation":"<p>The name of the policy.</p>"
},
"policyVersionId":{
"shape":"PolicyVersionId",
"documentation":"<p>The ID of the version of the policy associated with the resource.</p>"
}
},
"documentation":"<p>Information about the version of the policy associated with the resource.</p>"
},
"PolicyVersions":{
"type":"list",
"member":{"shape":"PolicyVersion"}
},
"Port":{
"type":"integer",
"max":65535,
"min":0
},
"Ports":{
"type":"list",
"member":{"shape":"Port"}
},
"PresignedUrlConfig":{
"type":"structure",
"members":{
@ -7283,6 +8823,8 @@
"QueuedThings":{"type":"integer"},
"RangeKeyField":{"type":"string"},
"RangeKeyValue":{"type":"string"},
"ReasonForNonCompliance":{"type":"string"},
"ReasonForNonComplianceCode":{"type":"string"},
"Recursive":{"type":"boolean"},
"RecursiveWithoutDefault":{"type":"boolean"},
"RegisterCACertificateRequest":{
@ -7390,7 +8932,10 @@
"RegisterThingResponse":{
"type":"structure",
"members":{
"certificatePem":{"shape":"CertificatePem"},
"certificatePem":{
"shape":"CertificatePem",
"documentation":"<p>.</p>"
},
"resourceArns":{
"shape":"ResourceArns",
"documentation":"<p>ARNs for the generated resources.</p>"
@ -7464,6 +9009,28 @@
"documentation":"<p>The input for the RejectCertificateTransfer operation.</p>"
},
"RejectedThings":{"type":"integer"},
"RelatedResource":{
"type":"structure",
"members":{
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource.</p>"
},
"resourceIdentifier":{
"shape":"ResourceIdentifier",
"documentation":"<p>Information identifying the resource.</p>"
},
"additionalInfo":{
"shape":"StringMap",
"documentation":"<p>Additional information about the resource.</p>"
}
},
"documentation":"<p>Information about a related resource.</p>"
},
"RelatedResources":{
"type":"list",
"member":{"shape":"RelatedResource"}
},
"RemoveAutoRegistration":{"type":"boolean"},
"RemoveThingFromThingGroupRequest":{
"type":"structure",
@ -7566,6 +9133,36 @@
"key":{"shape":"ResourceLogicalId"},
"value":{"shape":"ResourceArn"}
},
"ResourceIdentifier":{
"type":"structure",
"members":{
"deviceCertificateId":{
"shape":"CertificateId",
"documentation":"<p>The ID of the certificate attached to the resource.</p>"
},
"caCertificateId":{
"shape":"CertificateId",
"documentation":"<p>The ID of the CA certificate used to authorize the certificate.</p>"
},
"cognitoIdentityPoolId":{
"shape":"CognitoIdentityPoolId",
"documentation":"<p>The ID of the Cognito Identity Pool.</p>"
},
"clientId":{
"shape":"ClientId",
"documentation":"<p>The client ID.</p>"
},
"policyVersionIdentifier":{
"shape":"PolicyVersionIdentifier",
"documentation":"<p>The version of the policy associated with the resource.</p>"
},
"account":{
"shape":"AwsAccountId",
"documentation":"<p>The account with which the resource is associated.</p>"
}
},
"documentation":"<p>Information identifying the non-compliant resource.</p>"
},
"ResourceLogicalId":{"type":"string"},
"ResourceNotFoundException":{
"type":"structure",
@ -7582,12 +9179,26 @@
"ResourceRegistrationFailureException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
"message":{
"shape":"errorMessage",
"documentation":"<p>The message for the exception.</p>"
}
},
"documentation":"<p>The resource registration failed.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ResourceType":{
"type":"string",
"enum":[
"DEVICE_CERTIFICATE",
"CA_CERTIFICATE",
"IOT_POLICY",
"COGNITO_IDENTITY_POOL",
"CLIENT_ID",
"ACCOUNT_SETTINGS"
]
},
"Resources":{
"type":"list",
"member":{"shape":"Resource"}
@ -7743,6 +9354,43 @@
"type":"string",
"min":40
},
"ScheduledAuditArn":{"type":"string"},
"ScheduledAuditMetadata":{
"type":"structure",
"members":{
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit.</p>"
},
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
},
"frequency":{
"shape":"AuditFrequency",
"documentation":"<p>How often the scheduled audit takes place.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit is run (if the <code>frequency</code> is \"MONTHLY\"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit is run (if the <code>frequency</code> is \"WEEKLY\" or \"BIWEEKLY\").</p>"
}
},
"documentation":"<p>Information about the scheduled audit.</p>"
},
"ScheduledAuditMetadataList":{
"type":"list",
"member":{"shape":"ScheduledAuditMetadata"}
},
"ScheduledAuditName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9_-]+"
},
"SearchIndexRequest":{
"type":"structure",
"required":["queryString"],
@ -7787,6 +9435,74 @@
"member":{"shape":"AttributeName"}
},
"Seconds":{"type":"integer"},
"SecurityProfileArn":{"type":"string"},
"SecurityProfileDescription":{
"type":"string",
"max":1000,
"pattern":"[\\p{Graph}\\x20]*"
},
"SecurityProfileIdentifier":{
"type":"structure",
"required":[
"name",
"arn"
],
"members":{
"name":{
"shape":"SecurityProfileName",
"documentation":"<p>The name you have given to the security profile.</p>"
},
"arn":{
"shape":"SecurityProfileArn",
"documentation":"<p>The ARN of the security profile.</p>"
}
},
"documentation":"<p>Identifying information for a Device Defender security profile.</p>"
},
"SecurityProfileIdentifiers":{
"type":"list",
"member":{"shape":"SecurityProfileIdentifier"}
},
"SecurityProfileName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9:_-]+"
},
"SecurityProfileTarget":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"SecurityProfileTargetArn",
"documentation":"<p>The ARN of the security profile.</p>"
}
},
"documentation":"<p>A target to which an alert is sent when a security profile behavior is violated.</p>"
},
"SecurityProfileTargetArn":{"type":"string"},
"SecurityProfileTargetMapping":{
"type":"structure",
"members":{
"securityProfileIdentifier":{
"shape":"SecurityProfileIdentifier",
"documentation":"<p>Information that identifies the security profile.</p>"
},
"target":{
"shape":"SecurityProfileTarget",
"documentation":"<p>Information about the target (thing group) associated with the security profile.</p>"
}
},
"documentation":"<p>Information about a security profile and the target associated with it.</p>"
},
"SecurityProfileTargetMappings":{
"type":"list",
"member":{"shape":"SecurityProfileTargetMapping"}
},
"SecurityProfileTargets":{
"type":"list",
"member":{"shape":"SecurityProfileTarget"}
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
@ -7882,7 +9598,7 @@
"members":{
"roleArn":{
"shape":"AwsArn",
"documentation":"<p>The role ARN that allows IoT to write to Cloudwatch logs.</p>"
"documentation":"<p>The ARN of the role that allows IoT to write to Cloudwatch logs.</p>"
},
"defaultLogLevel":{
"shape":"LogLevel",
@ -7890,7 +9606,7 @@
},
"disableAllLogs":{
"shape":"DisableAllLogs",
"documentation":"<p>Set to true to disable all logs, otherwise set to false.</p>"
"documentation":"<p>If true all logs are disabled. The default is false.</p>"
}
}
},
@ -7958,6 +9674,25 @@
},
"documentation":"<p>Describes an action to publish data to an Amazon SQS queue.</p>"
},
"StartOnDemandAuditTaskRequest":{
"type":"structure",
"required":["targetCheckNames"],
"members":{
"targetCheckNames":{
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.</p>"
}
}
},
"StartOnDemandAuditTaskResponse":{
"type":"structure",
"members":{
"taskId":{
"shape":"AuditTaskId",
"documentation":"<p>The ID of the on-demand audit you started.</p>"
}
}
},
"StartThingRegistrationTaskRequest":{
"type":"structure",
"required":[
@ -7994,6 +9729,7 @@
}
}
},
"StateMachineName":{"type":"string"},
"StateReason":{"type":"string"},
"StateValue":{"type":"string"},
"Status":{
@ -8006,6 +9742,28 @@
"Cancelling"
]
},
"StepFunctionsAction":{
"type":"structure",
"required":[
"stateMachineName",
"roleArn"
],
"members":{
"executionNamePrefix":{
"shape":"ExecutionNamePrefix",
"documentation":"<p>(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.</p>"
},
"stateMachineName":{
"shape":"StateMachineName",
"documentation":"<p>The name of the Step Functions state machine whose execution will be started.</p>"
},
"roleArn":{
"shape":"AwsArn",
"documentation":"<p>The ARN of the role that grants IoT permission to start execution of a state machine (\"Action\":\"states:StartExecution\").</p>"
}
},
"documentation":"<p>Starts execution of a Step Functions state machine.</p>"
},
"StopThingRegistrationTaskRequest":{
"type":"structure",
"required":["taskId"],
@ -8139,10 +9897,20 @@
"type":"list",
"member":{"shape":"StreamSummary"}
},
"String":{"type":"string"},
"StringMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"SucceededThings":{"type":"integer"},
"TableName":{"type":"string"},
"Target":{"type":"string"},
"TargetArn":{"type":"string"},
"TargetAuditCheckNames":{
"type":"list",
"member":{"shape":"AuditCheckName"}
},
"TargetSelection":{
"type":"string",
"enum":[
@ -8163,6 +9931,40 @@
"type":"list",
"member":{"shape":"TaskId"}
},
"TaskStatistics":{
"type":"structure",
"members":{
"totalChecks":{
"shape":"TotalChecksCount",
"documentation":"<p>The number of checks in this audit.</p>"
},
"inProgressChecks":{
"shape":"InProgressChecksCount",
"documentation":"<p>The number of checks in progress.</p>"
},
"waitingForDataCollectionChecks":{
"shape":"WaitingForDataCollectionChecksCount",
"documentation":"<p>The number of checks waiting for data collection.</p>"
},
"compliantChecks":{
"shape":"CompliantChecksCount",
"documentation":"<p>The number of checks that found compliant resources.</p>"
},
"nonCompliantChecks":{
"shape":"NonCompliantChecksCount",
"documentation":"<p>The number of checks that found non-compliant resources.</p>"
},
"failedChecks":{
"shape":"FailedChecksCount",
"documentation":"<p>The number of checks </p>"
},
"canceledChecks":{
"shape":"CanceledChecksCount",
"documentation":"<p>The number of checks that did not run because the audit was canceled.</p>"
}
},
"documentation":"<p>Statistics for the checks performed during the audit.</p>"
},
"TemplateBody":{"type":"string"},
"TestAuthorizationRequest":{
"type":"structure",
@ -8493,9 +10295,10 @@
"error":{"httpStatusCode":429},
"exception":true
},
"Timestamp":{"type":"timestamp"},
"Token":{
"type":"string",
"max":1024,
"max":6144,
"min":1
},
"TokenKeyName":{
@ -8614,6 +10417,8 @@
},
"documentation":"<p>Describes a rule.</p>"
},
"TotalChecksCount":{"type":"integer"},
"TotalResourcesCount":{"type":"long"},
"TransferAlreadyCompletedException":{
"type":"structure",
"members":{
@ -8713,6 +10518,32 @@
"exception":true
},
"UndoDeprecate":{"type":"boolean"},
"UnsignedLong":{
"type":"long",
"min":0
},
"UpdateAccountAuditConfigurationRequest":{
"type":"structure",
"members":{
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as necessary when performing an audit.</p>"
},
"auditNotificationTargetConfigurations":{
"shape":"AuditNotificationTargetConfigurations",
"documentation":"<p>Information about the targets to which audit notifications are sent.</p>"
},
"auditCheckConfigurations":{
"shape":"AuditCheckConfigurations",
"documentation":"<p>Specifies which audit checks are enabled and disabled for this account. Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are currently enabled.</p> <p>Note that some data collection may begin immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.</p> <p>You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.</p> <p>On the first call to <code>UpdateAccountAuditConfiguration</code> this parameter is required and must specify at least one enabled check.</p>"
}
}
},
"UpdateAccountAuditConfigurationResponse":{
"type":"structure",
"members":{
}
},
"UpdateAuthorizerRequest":{
"type":"structure",
"required":["authorizerName"],
@ -8870,6 +10701,110 @@
}
}
},
"UpdateScheduledAuditRequest":{
"type":"structure",
"required":["scheduledAuditName"],
"members":{
"frequency":{
"shape":"AuditFrequency",
"documentation":"<p>How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The actual start time of each audit is determined by the system.</p>"
},
"dayOfMonth":{
"shape":"DayOfMonth",
"documentation":"<p>The day of the month on which the scheduled audit takes place. Can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.</p>"
},
"dayOfWeek":{
"shape":"DayOfWeek",
"documentation":"<p>The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\" or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".</p>"
},
"targetCheckNames":{
"shape":"TargetAuditCheckNames",
"documentation":"<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks including those that are enabled or <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"
},
"scheduledAuditName":{
"shape":"ScheduledAuditName",
"documentation":"<p>The name of the scheduled audit. (Max. 128 chars)</p>",
"location":"uri",
"locationName":"scheduledAuditName"
}
}
},
"UpdateScheduledAuditResponse":{
"type":"structure",
"members":{
"scheduledAuditArn":{
"shape":"ScheduledAuditArn",
"documentation":"<p>The ARN of the scheduled audit.</p>"
}
}
},
"UpdateSecurityProfileRequest":{
"type":"structure",
"required":["securityProfileName"],
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile you want to update.</p>",
"location":"uri",
"locationName":"securityProfileName"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>A description of the security profile.</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"expectedVersion":{
"shape":"OptionalVersion",
"documentation":"<p>The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a <code>VersionConflictException</code> is thrown.</p>",
"location":"querystring",
"locationName":"expectedVersion"
}
}
},
"UpdateSecurityProfileResponse":{
"type":"structure",
"members":{
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile that was updated.</p>"
},
"securityProfileArn":{
"shape":"SecurityProfileArn",
"documentation":"<p>The ARN of the security profile that was updated.</p>"
},
"securityProfileDescription":{
"shape":"SecurityProfileDescription",
"documentation":"<p>The description of the security profile.</p>"
},
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
},
"alertTargets":{
"shape":"AlertTargets",
"documentation":"<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>The updated version of the security profile.</p>"
},
"creationDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was created.</p>"
},
"lastModifiedDate":{
"shape":"Timestamp",
"documentation":"<p>The time the security profile was last modified.</p>"
}
}
},
"UpdateStreamRequest":{
"type":"structure",
"required":["streamId"],
@ -9005,6 +10940,44 @@
"documentation":"<p>The output from the UpdateThing operation.</p>"
},
"UseBase64":{"type":"boolean"},
"Valid":{"type":"boolean"},
"ValidateSecurityProfileBehaviorsRequest":{
"type":"structure",
"required":["behaviors"],
"members":{
"behaviors":{
"shape":"Behaviors",
"documentation":"<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"
}
}
},
"ValidateSecurityProfileBehaviorsResponse":{
"type":"structure",
"members":{
"valid":{
"shape":"Valid",
"documentation":"<p>True if the behaviors were valid.</p>"
},
"validationErrors":{
"shape":"ValidationErrors",
"documentation":"<p>The list of any errors found in the behaviors.</p>"
}
}
},
"ValidationError":{
"type":"structure",
"members":{
"errorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>The description of an error found in the behaviors.</p>"
}
},
"documentation":"<p>Information about an error found in a behavior specification.</p>"
},
"ValidationErrors":{
"type":"list",
"member":{"shape":"ValidationError"}
},
"Value":{"type":"string"},
"Version":{"type":"long"},
"VersionConflictException":{
@ -9032,9 +11005,62 @@
"error":{"httpStatusCode":409},
"exception":true
},
"ViolationEvent":{
"type":"structure",
"members":{
"violationId":{
"shape":"ViolationId",
"documentation":"<p>The ID of the violation event.</p>"
},
"thingName":{
"shape":"ThingName",
"documentation":"<p>The name of the thing responsible for the violation event.</p>"
},
"securityProfileName":{
"shape":"SecurityProfileName",
"documentation":"<p>The name of the security profile whose behavior was violated.</p>"
},
"behavior":{
"shape":"Behavior",
"documentation":"<p>The behavior which was violated.</p>"
},
"metricValue":{
"shape":"MetricValue",
"documentation":"<p>The value of the metric (the measurement).</p>"
},
"violationEventType":{
"shape":"ViolationEventType",
"documentation":"<p>The type of violation event.</p>"
},
"violationEventTime":{
"shape":"Timestamp",
"documentation":"<p>The time the violation event occurred.</p>"
}
},
"documentation":"<p>Information about a Device Defender security profile behavior violation.</p>"
},
"ViolationEventType":{
"type":"string",
"enum":[
"in-alarm",
"alarm-cleared",
"alarm-invalidated"
]
},
"ViolationEvents":{
"type":"list",
"member":{"shape":"ViolationEvent"}
},
"ViolationId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9\\-]+"
},
"WaitingForDataCollectionChecksCount":{"type":"integer"},
"errorMessage":{"type":"string"},
"resourceArn":{"type":"string"},
"resourceId":{"type":"string"}
},
"documentation":"<fullname>AWS IoT</fullname> <p>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.</p> <p>For more information about how AWS IoT works, see the <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html\">Developer Guide</a>.</p>"
"documentation":"<fullname>AWS IoT</fullname> <p>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.</p> <p>For more information about how AWS IoT works, see the <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html\">Developer Guide</a>.</p> <p>For information about how to use the credentials provider for AWS IoT, see <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html\">Authorizing Direct Calls to AWS Services</a>.</p>"
}

58
botocore/data/iotanalytics/2017-11-27/service-2.json
View file

@ -761,6 +761,16 @@
"min":1,
"pattern":"^[a-zA-Z0-9_]+$"
},
"ChannelStatistics":{
"type":"structure",
"members":{
"size":{
"shape":"EstimatedResourceSize",
"documentation":"<p>The estimated size of the channel.</p>"
}
},
"documentation":"<p>Statistics information about the channel.</p>"
},
"ChannelStatus":{
"type":"string",
"enum":[
@ -1162,6 +1172,16 @@
"min":1,
"pattern":"^[a-zA-Z0-9_]+$"
},
"DatastoreStatistics":{
"type":"structure",
"members":{
"size":{
"shape":"EstimatedResourceSize",
"documentation":"<p>The estimated size of the data store.</p>"
}
},
"documentation":"<p>Statistics information about the data store.</p>"
},
"DatastoreStatus":{
"type":"string",
"enum":[
@ -1271,6 +1291,12 @@
"documentation":"<p>The name of the channel whose information is retrieved.</p>",
"location":"uri",
"locationName":"channelName"
},
"includeStatistics":{
"shape":"IncludeStatisticsFlag",
"documentation":"<p>If true, include statistics about the channel in the response.</p>",
"location":"querystring",
"locationName":"includeStatistics"
}
}
},
@ -1280,6 +1306,10 @@
"channel":{
"shape":"Channel",
"documentation":"<p>An object that contains information about the channel.</p>"
},
"statistics":{
"shape":"ChannelStatistics",
"documentation":"<p>Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.</p>"
}
}
},
@ -1313,6 +1343,12 @@
"documentation":"<p>The name of the data store</p>",
"location":"uri",
"locationName":"datastoreName"
},
"includeStatistics":{
"shape":"IncludeStatisticsFlag",
"documentation":"<p>If true, include statistics about the data store in the response.</p>",
"location":"querystring",
"locationName":"includeStatistics"
}
}
},
@ -1322,6 +1358,10 @@
"datastore":{
"shape":"Datastore",
"documentation":"<p>Information about the data store.</p>"
},
"statistics":{
"shape":"DatastoreStatistics",
"documentation":"<p>Statistics about the data store. Included if the 'includeStatistics' parameter is set to true in the request.</p>"
}
}
},
@ -1428,6 +1468,20 @@
"EntryName":{"type":"string"},
"ErrorCode":{"type":"string"},
"ErrorMessage":{"type":"string"},
"EstimatedResourceSize":{
"type":"structure",
"members":{
"estimatedSizeInBytes":{
"shape":"SizeInBytes",
"documentation":"<p>The estimated size of the resource in bytes.</p>"
},
"estimatedOn":{
"shape":"Timestamp",
"documentation":"<p>The time when the estimate of the size of the resource was made.</p>"
}
},
"documentation":"<p>The estimated size of the resource.</p>"
},
"FilterActivity":{
"type":"structure",
"required":[
@ -1490,6 +1544,7 @@
}
}
},
"IncludeStatisticsFlag":{"type":"boolean"},
"InternalFailureException":{
"type":"structure",
"members":{
@ -1776,7 +1831,7 @@
},
"payload":{
"shape":"MessagePayload",
"documentation":"<p>The payload of the message.</p>"
"documentation":"<p>The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).</p>"
}
},
"documentation":"<p>Information about a message.</p>"
@ -2145,6 +2200,7 @@
"exception":true,
"fault":true
},
"SizeInBytes":{"type":"double"},
"SqlQuery":{"type":"string"},
"SqlQueryDatasetAction":{
"type":"structure",

169
botocore/data/kinesis-video-archived-media/2017-09-30/service-2.json
View file

File diff suppressed because one or more lines are too long

413
botocore/data/kinesis/2013-12-02/service-2.json
View file

@ -5,6 +5,7 @@
"endpointPrefix":"kinesis",
"jsonVersion":"1.1",
"protocol":"json",
"protocolSettings":{"h2":"eventstream"},
"serviceAbbreviation":"Kinesis",
"serviceFullName":"Amazon Kinesis",
"serviceId":"Kinesis",
@ -26,7 +27,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Adds or updates tags for the specified Kinesis data stream. Each stream can have up to 10 tags.</p> <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys.</p> <p> <a>AddTagsToStream</a> has a limit of five transactions per second per account.</p>"
"documentation":"<p>Adds or updates tags for the specified Kinesis data stream. Each time you invoke this operation, you can specify up to 10 tags. If you want to add more than 10 tags to your stream, you can invoke this operation multiple times. In total, each stream can have up to 50 tags.</p> <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys.</p> <p> <a>AddTagsToStream</a> has a limit of five transactions per second per account.</p>"
},
"CreateStream":{
"name":"CreateStream",
@ -66,10 +67,25 @@
"input":{"shape":"DeleteStreamInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception <code>ResourceNotFoundException</code>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Kinesis Data Streams completes the deletion.</p> <p> <b>Note:</b> Kinesis Data Streams might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete.</p> <p>When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.</p> <p>You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p> <a>DeleteStream</a> has a limit of five transactions per second per account.</p>"
},
"DeregisterStreamConsumer":{
"name":"DeregisterStreamConsumer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterStreamConsumerInput"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgumentException"}
],
"documentation":"<p>To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the <a>ListStreamConsumers</a> operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.</p> <p>This operation has a limit of five transactions per second per account.</p>"
},
"DescribeLimits":{
"name":"DescribeLimits",
"http":{
@ -97,6 +113,21 @@
],
"documentation":"<p>Describes the specified Kinesis data stream.</p> <p>The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.</p> <p>You can limit the number of shards returned by each call. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html\">Retrieving Shards from a Stream</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.</p> <p>This operation has a limit of 10 transactions per second per account.</p>"
},
"DescribeStreamConsumer":{
"name":"DescribeStreamConsumer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeStreamConsumerInput"},
"output":{"shape":"DescribeStreamConsumerOutput"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgumentException"}
],
"documentation":"<p>To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the <a>ListStreamConsumers</a> operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.</p> <p>This operation has a limit of 20 transactions per second per account.</p>"
},
"DescribeStreamSummary":{
"name":"DescribeStreamSummary",
"http":{
@ -163,7 +194,7 @@
{"shape":"KMSOptInRequired"},
{"shape":"KMSThrottlingException"}
],
"documentation":"<p>Gets data records from a Kinesis data stream's shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.</p> <p>You can scale by provisioning multiple shards per stream while considering service limits (for more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. If the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.</p> <p>Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit.</p> <p>The size of the data returned by <a>GetRecords</a> varies depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next five seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next one second throw <code>ProvisionedThroughputExceededException</code>. <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second.</p> <p>To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html\">Monitoring</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>).</p> <p>Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with <a>PutRecords</a>). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.</p>"
"documentation":"<p>Gets data records from a Kinesis data stream's shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.</p> <p>You can scale by provisioning multiple shards per stream while considering service limits (for more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. If the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.</p> <p>Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000.</p> <p>The size of the data returned by <a>GetRecords</a> varies depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw <code>ProvisionedThroughputExceededException</code>. <a>GetRecords</a> doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to <a>GetRecords</a>. However, it's possible that the application will get exceptions for longer than 1 second.</p> <p>To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html\">Monitoring</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>).</p> <p>Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with <a>PutRecords</a>). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.</p> <p>This operation has a limit of five transactions per second per account.</p>"
},
"GetShardIterator":{
"name":"GetShardIterator",
@ -178,7 +209,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"ProvisionedThroughputExceededException"}
],
"documentation":"<p>Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.</p> <p>A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.</p> <p>You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type. Alternatively, the parameter can read right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. In the request, you can specify the shard iterator type <code>AT_TIMESTAMP</code> to read records from an arbitrary point in time, <code>TRIM_HORIZON</code> to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or <code>LATEST</code> so that you always read the most recent data in the shard. </p> <p>When you read repeatedly from a stream, use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and for subsequent reads use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code>. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </p> <p>If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>, and <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>If the shard is closed, <a>GetShardIterator</a> returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using <a>SplitShard</a> or <a>MergeShards</a>.</p> <p> <a>GetShardIterator</a> has a limit of five transactions per second per account per open shard.</p>"
"documentation":"<p>Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.</p> <p>A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.</p> <p>You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type. Alternatively, the parameter can read right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. In the request, you can specify the shard iterator type <code>AT_TIMESTAMP</code> to read records from an arbitrary point in time, <code>TRIM_HORIZON</code> to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or <code>LATEST</code> so that you always read the most recent data in the shard. </p> <p>When you read repeatedly from a stream, use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and for subsequent reads use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code>. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </p> <p>If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>, and <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>If the shard is closed, <a>GetShardIterator</a> returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using <a>SplitShard</a> or <a>MergeShards</a>.</p> <p> <a>GetShardIterator</a> has a limit of five transactions per second per account per open shard.</p>"
},
"IncreaseStreamRetentionPeriod":{
"name":"IncreaseStreamRetentionPeriod",
@ -210,7 +241,24 @@
{"shape":"ExpiredNextTokenException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Lists the shards in a stream and provides information about each shard.</p> <important> <p>This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see <a href=\"https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html\">Controlling Access to Amazon Kinesis Data Streams Resources Using IAM</a>.</p> </important>"
"documentation":"<p>Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream.</p> <important> <p>This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see <a href=\"https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html\">Controlling Access to Amazon Kinesis Data Streams Resources Using IAM</a>.</p> </important>"
},
"ListStreamConsumers":{
"name":"ListStreamConsumers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListStreamConsumersInput"},
"output":{"shape":"ListStreamConsumersOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"},
{"shape":"ExpiredNextTokenException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.</p> <p>This operation has a limit of 10 transactions per second per account.</p>"
},
"ListStreams":{
"name":"ListStreams",
@ -297,6 +345,22 @@
],
"documentation":"<p>Writes multiple data records into a Kinesis data stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data into the stream for data ingestion and processing. </p> <p>Each <code>PutRecords</code> request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array.</p> <p>The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream.</p> <p>An unsuccessfully processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>"
},
"RegisterStreamConsumer":{
"name":"RegisterStreamConsumer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterStreamConsumerInput"},
"output":{"shape":"RegisterStreamConsumerOutput"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can read data from the stream at a rate of up to 2 MiB per second. This rate is unaffected by the total number of consumers that read from the same stream.</p> <p>You can register up to 5 consumers per stream. A given consumer can only be registered with one stream.</p> <p>This operation has a limit of five transactions per second per account.</p>"
},
"RemoveTagsFromStream":{
"name":"RemoveTagsFromStream",
"http":{
@ -325,7 +389,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html\">Split a Shard</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request.</p> <p> <code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Kinesis Data Streams immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Kinesis Data Streams sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>.</p> <p>If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </p> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>If you try to operate on too many streams simultaneously using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a>, and/or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p> <code>SplitShard</code> has a limit of five transactions per second per account.</p>"
"documentation":"<p>Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html\">Split a Shard</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request.</p> <p> <code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Kinesis Data Streams immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Kinesis Data Streams sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>.</p> <p>If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </p> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>If you try to operate on too many streams simultaneously using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a>, and/or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p> <code>SplitShard</code> has a limit of five transactions per second per account.</p>"
},
"StartStreamEncryption":{
"name":"StartStreamEncryption",
@ -346,7 +410,7 @@
{"shape":"KMSOptInRequired"},
{"shape":"KMSThrottlingException"}
],
"documentation":"<p>Enables or updates server-side encryption using an AWS KMS key for a specified stream. </p> <p>Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, encryption begins for records written to the stream. </p> <p>API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.</p> <p>Note: It can take up to five seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
"documentation":"<p>Enables or updates server-side encryption using an AWS KMS key for a specified stream. </p> <p>Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, encryption begins for records written to the stream. </p> <p>API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.</p> <p>Note: It can take up to 5 seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
},
"StopStreamEncryption":{
"name":"StopStreamEncryption",
@ -361,7 +425,23 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disables server-side encryption for a specified stream. </p> <p>Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, records written to the stream are no longer encrypted by Kinesis Data Streams. </p> <p>API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period. </p> <p>Note: It can take up to five seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
"documentation":"<p>Disables server-side encryption for a specified stream. </p> <p>Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, records written to the stream are no longer encrypted by Kinesis Data Streams. </p> <p>API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period. </p> <p>Note: It can take up to 5 seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
},
"SubscribeToShard":{
"name":"SubscribeToShard",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SubscribeToShardInput"},
"output":{"shape":"SubscribeToShardOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgumentException"},
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Call this operation from your consumer after you call <a>RegisterStreamConsumer</a> to register the consumer with Kinesis Data Streams. If the call succeeds, your consumer starts receiving events of type <a>SubscribeToShardEvent</a> for up to 5 minutes, after which time you need to call <code>SubscribeToShard</code> again to renew the subscription if you want to continue to receive records.</p> <p>You can make one call to <code>SubscribeToShard</code> per second per <code>ConsumerARN</code>. If your call succeeds, and then you call the operation again less than 5 seconds later, the second call generates a <a>ResourceInUseException</a>. If you call the operation a second time more than 5 seconds after the first call succeeds, the second call succeeds and the first connection gets shut down.</p>"
},
"UpdateShardCount":{
"name":"UpdateShardCount",
@ -377,7 +457,7 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the shard count of the specified stream to the specified number of shards.</p> <p>Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is <code>UPDATING</code>.</p> <p>To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.</p> <p>This operation has the following limits. You cannot do the following:</p> <ul> <li> <p>Scale more than twice per rolling 24-hour period per stream</p> </li> <li> <p>Scale up to more than double your current shard count for a stream</p> </li> <li> <p>Scale down below half your current shard count for a stream</p> </li> <li> <p>Scale up to more than 500 shards in a stream</p> </li> <li> <p>Scale a stream with more than 500 shards down unless the result is less than 500 shards</p> </li> <li> <p>Scale up to more than the shard limit for your account</p> </li> </ul> <p>For the default limits for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the <a href=\"https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&amp;limitType=service-code-kinesis\">limits form</a>.</p>"
"documentation":"<p>Updates the shard count of the specified stream to the specified number of shards.</p> <p>Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is <code>UPDATING</code>.</p> <p>To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.</p> <p>This operation has the following default limits. By default, you cannot do the following:</p> <ul> <li> <p>Scale more than twice per rolling 24-hour period per stream</p> </li> <li> <p>Scale up to more than double your current shard count for a stream</p> </li> <li> <p>Scale down below half your current shard count for a stream</p> </li> <li> <p>Scale up to more than 500 shards in a stream</p> </li> <li> <p>Scale a stream with more than 500 shards down unless the result is less than 500 shards</p> </li> <li> <p>Scale up to more than the shard limit for your account</p> </li> </ul> <p>For the default limits for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the <a href=\"https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&amp;limitType=service-code-kinesis\">limits form</a>.</p>"
}
},
"shapes":{
@ -394,12 +474,102 @@
},
"Tags":{
"shape":"TagMap",
"documentation":"<p>The set of key-value pairs to use to create the tags.</p>"
"documentation":"<p>A set of up to 10 key-value pairs to use to create the tags.</p>"
}
},
"documentation":"<p>Represents the input for <code>AddTagsToStream</code>.</p>"
},
"BooleanObject":{"type":"boolean"},
"Consumer":{
"type":"structure",
"required":[
"ConsumerName",
"ConsumerARN",
"ConsumerStatus",
"ConsumerCreationTimestamp"
],
"members":{
"ConsumerName":{
"shape":"ConsumerName",
"documentation":"<p>The name of the consumer is something you choose when you register the consumer.</p>"
},
"ConsumerARN":{
"shape":"ConsumerARN",
"documentation":"<p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call <a>SubscribeToShard</a>.</p> <p>If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.</p>"
},
"ConsumerStatus":{
"shape":"ConsumerStatus",
"documentation":"<p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code> states.</p>"
},
"ConsumerCreationTimestamp":{
"shape":"Timestamp",
"documentation":"<p/>"
}
},
"documentation":"<p>An object that represents the details of the consumer you registered.</p>"
},
"ConsumerARN":{
"type":"string",
"max":2048,
"min":1,
"pattern":"^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+"
},
"ConsumerCountObject":{
"type":"integer",
"max":1000000,
"min":0
},
"ConsumerDescription":{
"type":"structure",
"required":[
"ConsumerName",
"ConsumerARN",
"ConsumerStatus",
"ConsumerCreationTimestamp",
"StreamARN"
],
"members":{
"ConsumerName":{
"shape":"ConsumerName",
"documentation":"<p>The name of the consumer is something you choose when you register the consumer.</p>"
},
"ConsumerARN":{
"shape":"ConsumerARN",
"documentation":"<p>When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call <a>SubscribeToShard</a>.</p> <p>If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.</p>"
},
"ConsumerStatus":{
"shape":"ConsumerStatus",
"documentation":"<p>A consumer can't read data while in the <code>CREATING</code> or <code>DELETING</code> states.</p>"
},
"ConsumerCreationTimestamp":{
"shape":"Timestamp",
"documentation":"<p/>"
},
"StreamARN":{
"shape":"StreamARN",
"documentation":"<p>The ARN of the stream with which you registered the consumer.</p>"
}
},
"documentation":"<p>An object that represents the details of a registered consumer.</p>"
},
"ConsumerList":{
"type":"list",
"member":{"shape":"Consumer"}
},
"ConsumerName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9_.-]+"
},
"ConsumerStatus":{
"type":"string",
"enum":[
"CREATING",
"DELETING",
"ACTIVE"
]
},
"CreateStreamInput":{
"type":"structure",
"required":[
@ -448,10 +618,31 @@
"StreamName":{
"shape":"StreamName",
"documentation":"<p>The name of the stream to delete.</p>"
},
"EnforceConsumerDeletion":{
"shape":"BooleanObject",
"documentation":"<p>If this parameter is unset (<code>null</code>) or if you set it to <code>false</code>, and the stream has registered consumers, the call to <code>DeleteStream</code> fails with a <code>ResourceInUseException</code>. </p>"
}
},
"documentation":"<p>Represents the input for <a>DeleteStream</a>.</p>"
},
"DeregisterStreamConsumerInput":{
"type":"structure",
"members":{
"StreamARN":{
"shape":"StreamARN",
"documentation":"<p>The ARN of the Kinesis data stream that the consumer is registered with. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
},
"ConsumerName":{
"shape":"ConsumerName",
"documentation":"<p>The name that you gave to the consumer.</p>"
},
"ConsumerARN":{
"shape":"ConsumerARN",
"documentation":"<p>The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.</p>"
}
}
},
"DescribeLimitsInput":{
"type":"structure",
"members":{
@ -474,6 +665,33 @@
}
}
},
"DescribeStreamConsumerInput":{
"type":"structure",
"members":{
"StreamARN":{
"shape":"StreamARN",
"documentation":"<p>The ARN of the Kinesis data stream that the consumer is registered with. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
},
"ConsumerName":{
"shape":"ConsumerName",
"documentation":"<p>The name that you gave to the consumer.</p>"
},
"ConsumerARN":{
"shape":"ConsumerARN",
"documentation":"<p>The ARN returned by Kinesis Data Streams when you registered the consumer.</p>"
}
}
},
"DescribeStreamConsumerOutput":{
"type":"structure",
"required":["ConsumerDescription"],
"members":{
"ConsumerDescription":{
"shape":"ConsumerDescription",
"documentation":"<p>An object that represents the details of the consumer.</p>"
}
}
},
"DescribeStreamInput":{
"type":"structure",
"required":["StreamName"],
@ -622,7 +840,7 @@
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The pagination token passed to the <code>ListShards</code> operation is expired. For more information, see <a>ListShardsInput$NextToken</a>.</p>",
"documentation":"<p>The pagination token passed to the operation is expired.</p>",
"exception":true
},
"GetRecordsInput":{
@ -745,6 +963,14 @@
},
"documentation":"<p>Represents the input for <a>IncreaseStreamRetentionPeriod</a>.</p>"
},
"InternalFailureException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true,
"fault":true
},
"InvalidArgumentException":{
"type":"structure",
"members":{
@ -851,7 +1077,7 @@
},
"ExclusiveStartShardId":{
"shape":"ShardId",
"documentation":"<p>The ID of the shard to start the list with. </p> <p>If you don't specify this parameter, the default behavior is for <code>ListShards</code> to list the shards starting with the first one in the stream.</p> <p>You cannot specify this parameter if you specify <code>NextToken</code>.</p>"
"documentation":"<p>Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows <code>ExclusiveStartShardId</code>.</p> <p>If you don't specify this parameter, the default behavior is for <code>ListShards</code> to list the shards starting with the first one in the stream.</p> <p>You cannot specify this parameter if you specify <code>NextToken</code>.</p>"
},
"MaxResults":{
"shape":"ListShardsInputLimit",
@ -881,6 +1107,46 @@
}
}
},
"ListStreamConsumersInput":{
"type":"structure",
"required":["StreamARN"],
"members":{
"StreamARN":{
"shape":"StreamARN",
"documentation":"<p>The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When the number of consumers that are registered with the data stream is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of consumers that are registered with the data stream, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListStreamConsumers</code> to list the next set of registered consumers.</p> <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you specify <code>NextToken</code> because the latter unambiguously identifies the stream.</p> <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that is less than the number of consumers that the operation returns if you don't specify <code>MaxResults</code>, the response will contain a new <code>NextToken</code> value. You can use the new <code>NextToken</code> value in a subsequent call to the <code>ListStreamConsumers</code> operation to list the next set of consumers.</p> <important> <p>Tokens expire after 300 seconds. When you obtain a value for <code>NextToken</code> in the response to a call to <code>ListStreamConsumers</code>, you have 300 seconds to use that value. If you specify an expired token in a call to <code>ListStreamConsumers</code>, you get <code>ExpiredNextTokenException</code>.</p> </important>"
},
"MaxResults":{
"shape":"ListStreamConsumersInputLimit",
"documentation":"<p>The maximum number of consumers that you want a single call of <code>ListStreamConsumers</code> to return.</p>"
},
"StreamCreationTimestamp":{
"shape":"Timestamp",
"documentation":"<p>Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for. </p> <p>You can't specify this parameter if you specify the NextToken parameter. </p>"
}
}
},
"ListStreamConsumersInputLimit":{
"type":"integer",
"max":10000,
"min":1
},
"ListStreamConsumersOutput":{
"type":"structure",
"members":{
"Consumers":{
"shape":"ConsumerList",
"documentation":"<p>An array of JSON objects. Each object represents one registered consumer.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When the number of consumers that are registered with the data stream is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of registered consumers, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListStreamConsumers</code> to list the next set of registered consumers. For more information about the use of this pagination token when calling the <code>ListStreamConsumers</code> operation, see <a>ListStreamConsumersInput$NextToken</a>.</p> <important> <p>Tokens expire after 300 seconds. When you obtain a value for <code>NextToken</code> in the response to a call to <code>ListStreamConsumers</code>, you have 300 seconds to use that value. If you specify an expired token in a call to <code>ListStreamConsumers</code>, you get <code>ExpiredNextTokenException</code>.</p> </important>"
}
}
},
"ListStreamsInput":{
"type":"structure",
"members":{
@ -939,7 +1205,7 @@
},
"ListTagsForStreamInputLimit":{
"type":"integer",
"max":10,
"max":50,
"min":1
},
"ListTagsForStreamOutput":{
@ -1213,6 +1479,33 @@
"type":"list",
"member":{"shape":"Record"}
},
"RegisterStreamConsumerInput":{
"type":"structure",
"required":[
"StreamARN",
"ConsumerName"
],
"members":{
"StreamARN":{
"shape":"StreamARN",
"documentation":"<p>The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
},
"ConsumerName":{
"shape":"ConsumerName",
"documentation":"<p>For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.</p>"
}
}
},
"RegisterStreamConsumerOutput":{
"type":"structure",
"required":["Consumer"],
"members":{
"Consumer":{
"shape":"Consumer",
"documentation":"<p>An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.</p>"
}
}
},
"RemoveTagsFromStreamInput":{
"type":"structure",
"required":[
@ -1387,6 +1680,15 @@
}
}
},
"StartingPosition":{
"type":"structure",
"required":["Type"],
"members":{
"Type":{"shape":"ShardIteratorType"},
"SequenceNumber":{"shape":"SequenceNumber"},
"Timestamp":{"shape":"Timestamp"}
}
},
"StopStreamEncryptionInput":{
"type":"structure",
"required":[
@ -1409,7 +1711,12 @@
}
}
},
"StreamARN":{"type":"string"},
"StreamARN":{
"type":"string",
"max":2048,
"min":1,
"pattern":"arn:aws.*:kinesis:.*:\\d{12}:stream/.*"
},
"StreamDescription":{
"type":"structure",
"required":[
@ -1513,6 +1820,10 @@
"OpenShardCount":{
"shape":"ShardCountObject",
"documentation":"<p>The number of open shards in the stream.</p>"
},
"ConsumerCount":{
"shape":"ConsumerCountObject",
"documentation":"<p>The number of enhanced fan-out consumers registered with the stream.</p>"
}
},
"documentation":"<p>Represents the output for <a>DescribeStreamSummary</a> </p>"
@ -1536,6 +1847,76 @@
"UPDATING"
]
},
"SubscribeToShardEvent":{
"type":"structure",
"required":[
"Records",
"ContinuationSequenceNumber",
"MillisBehindLatest"
],
"members":{
"Records":{
"shape":"RecordList",
"documentation":"<p/>"
},
"ContinuationSequenceNumber":{
"shape":"SequenceNumber",
"documentation":"<p>Use this as <code>StartingSequenceNumber</code> in the next call to <a>SubscribeToShard</a>.</p>"
},
"MillisBehindLatest":{
"shape":"MillisBehindLatest",
"documentation":"<p>The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.</p>"
}
},
"documentation":"<p>After you call <a>SubscribeToShard</a>, Kinesis Data Streams sends events of this type to your consumer. </p>",
"event":true
},
"SubscribeToShardEventStream":{
"type":"structure",
"required":["SubscribeToShardEvent"],
"members":{
"SubscribeToShardEvent":{"shape":"SubscribeToShardEvent"},
"ResourceNotFoundException":{"shape":"ResourceNotFoundException"},
"ResourceInUseException":{"shape":"ResourceInUseException"},
"KMSDisabledException":{"shape":"KMSDisabledException"},
"KMSInvalidStateException":{"shape":"KMSInvalidStateException"},
"KMSAccessDeniedException":{"shape":"KMSAccessDeniedException"},
"KMSNotFoundException":{"shape":"KMSNotFoundException"},
"KMSOptInRequired":{"shape":"KMSOptInRequired"},
"KMSThrottlingException":{"shape":"KMSThrottlingException"},
"InternalFailureException":{"shape":"InternalFailureException"}
},
"eventstream":true
},
"SubscribeToShardInput":{
"type":"structure",
"required":[
"ConsumerARN",
"ShardId",
"StartingPosition"
],
"members":{
"ConsumerARN":{
"shape":"ConsumerARN",
"documentation":"<p>For this parameter, use the value you obtained when you called <a>RegisterStreamConsumer</a>.</p>"
},
"ShardId":{
"shape":"ShardId",
"documentation":"<p>The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use <a>ListShards</a>.</p>"
},
"StartingPosition":{"shape":"StartingPosition"}
}
},
"SubscribeToShardOutput":{
"type":"structure",
"required":["EventStream"],
"members":{
"EventStream":{
"shape":"SubscribeToShardEventStream",
"documentation":"<p>The event stream that your consumer can use to read records from the shard.</p>"
}
}
},
"Tag":{
"type":"structure",
"required":["Key"],
@ -1559,7 +1940,7 @@
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":10,
"max":50,
"min":1
},
"TagList":{
@ -1571,7 +1952,7 @@
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":10,
"max":50,
"min":1
},
"TagValue":{

9
botocore/data/kinesisvideo/2017-09-30/service-2.json
View file

@ -187,7 +187,8 @@
"PUT_MEDIA",
"GET_MEDIA",
"LIST_FRAGMENTS",
"GET_MEDIA_FOR_FRAGMENT_LIST"
"GET_MEDIA_FOR_FRAGMENT_LIST",
"GET_HLS_STREAMING_SESSION_URL"
]
},
"AccountStreamLimitExceededException":{
@ -234,7 +235,7 @@
},
"DataRetentionInHours":{
"shape":"DataRetentionInHours",
"documentation":"<p>The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.</p> <p>The default value is 0, indicating that the stream does not persist data.</p>"
"documentation":"<p>The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.</p> <p>The default value is 0, indicating that the stream does not persist data.</p> <p>When the <code>DataRetentionInHours</code> value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.</p>"
}
}
},
@ -699,7 +700,7 @@
},
"MediaType":{
"shape":"MediaType",
"documentation":"<p>The stream's media type. Use <code>MediaType</code> to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see <a href=\"http://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. If you choose to specify the <code>MediaType</code>, see <a href=\"https://tools.sietf.org/html/rfc6838#section-4.2\">Naming Requirements</a>.</p> <p>To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify <code>video/h264</code> as the <code>MediaType</code>.</p>"
"documentation":"<p>The stream's media type. Use <code>MediaType</code> to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see <a href=\"http://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. If you choose to specify the <code>MediaType</code>, see <a href=\"https://tools.ietf.org/html/rfc6838#section-4.2\">Naming Requirements</a>.</p> <p>To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify <code>video/h264</code> as the <code>MediaType</code>.</p>"
}
}
},
@ -719,7 +720,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The stream version that you specified is not the latest version. To get the latest version, use the <a href=\"http://docs.aws.amazon.com/kinesisvideo/latest/dg/API_DescribeStream.html\">DescribeStream</a> API.</p>",
"documentation":"<p>The stream version that you specified is not the latest version. To get the latest version, use the <a href=\"http://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html\">DescribeStream</a> API.</p>",
"error":{"httpStatusCode":400},
"exception":true
}

82
botocore/data/kms/2014-11-01/service-2.json
View file

@ -28,7 +28,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about scheduling and canceling deletion of a CMK, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about scheduling and canceling deletion of a CMK, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"CreateAlias":{
"name":"CreateAlias",
@ -46,7 +46,7 @@
{"shape":"LimitExceededException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as <a>Encrypt</a> and <a>GenerateDataKey</a>. </p> <p>Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region. </p> <p>Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a> operation.</p> <p>An alias must start with the word <code>alias</code> followed by a forward slash (<code>alias/</code>). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with <code>aws</code>; that alias name prefix is reserved by Amazon Web Services (AWS).</p> <p>The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.</p> <p>To map an existing alias to a different CMK, call <a>UpdateAlias</a>.</p>"
"documentation":"<p>Creates a display name for a customer-managed customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as <a>Encrypt</a> and <a>GenerateDataKey</a>. </p> <p>Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region. </p> <p>Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a> operation.</p> <p>The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with <b>aws/</b>. That alias name prefix is reserved for AWS managed CMKs.</p> <p>The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.</p> <p>To map an existing alias to a different CMK, call <a>UpdateAlias</a>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"CreateGrant":{
"name":"CreateGrant",
@ -66,7 +66,7 @@
{"shape":"LimitExceededException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies. </p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/grants.html\">Grants</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies. </p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter. For more information about grants, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/grants.html\">Grants</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"CreateKey":{
"name":"CreateKey",
@ -85,7 +85,7 @@
{"shape":"LimitExceededException"},
{"shape":"TagException"}
],
"documentation":"<p>Creates a customer master key (CMK) in the caller's AWS account.</p> <p>You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:</p> <ul> <li> <p>The <a>GenerateDataKey</a> operation</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">AWS Key Management Service Concepts</a> in the <i>AWS Key Management Service Developer Guide</i> </p> </li> </ul> <p>You cannot use this operation to create a CMK in a different AWS account.</p>"
"documentation":"<p>Creates a customer master key (CMK) in the caller's AWS account.</p> <p>You can use a CMK to encrypt small amounts of data (4 KiB or less) directly. But CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:</p> <ul> <li> <p>The <a>GenerateDataKey</a> operation</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">AWS Key Management Service Concepts</a> in the <i>AWS Key Management Service Developer Guide</i> </p> </li> </ul> <p>You cannot use this operation to create a CMK in a different AWS account.</p>"
},
"Decrypt":{
"name":"Decrypt",
@ -105,7 +105,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:</p> <ul> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> <li> <p> <a>Encrypt</a> </p> </li> </ul> <p>Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant <code>Decrypt</code> permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant <code>Decrypt</code> access in an IAM user policy. Instead grant <code>Decrypt</code> access only in key policies. If you must grant <code>Decrypt</code> access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.</p>"
"documentation":"<p>Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:</p> <ul> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> <li> <p> <a>Encrypt</a> </p> </li> </ul> <p>Whenever possible, use key policies to give users permission to call the Decrypt operation on the CMK, instead of IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for <code>Decrypt</code> permissions, limit the user to particular CMKs or particular trusted accounts.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"DeleteAlias":{
"name":"DeleteAlias",
@ -137,7 +137,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>When the specified CMK is in the <code>PendingDeletion</code> state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to <code>PendingImport</code>.</p> <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport the same key material into the CMK.</p>"
"documentation":"<p>Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>. You cannot perform this operation on a CMK in a different AWS account.</p> <p>When the specified CMK is in the <code>PendingDeletion</code> state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to <code>PendingImport</code>.</p> <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport the same key material into the CMK.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"DescribeKey":{
"name":"DescribeKey",
@ -153,7 +153,7 @@
{"shape":"DependencyTimeoutException"},
{"shape":"KMSInternalException"}
],
"documentation":"<p>Provides detailed information about the specified customer master key (CMK).</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p>"
"documentation":"<p>Provides detailed information about the specified customer master key (CMK).</p> <p>You can use <code>DescribeKey</code> on a predefined AWS alias, that is, an AWS alias with no key ID. When you do, AWS KMS associates the alias with an <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">AWS managed CMK</a> and returns its <code>KeyId</code> and <code>Arn</code> in the response.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p>"
},
"DisableKey":{
"name":"DisableKey",
@ -169,7 +169,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about how key state affects the use of a CMK, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.</p> <p>For more information about how key state affects the use of a CMK, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"DisableKeyRotation":{
"name":"DisableKeyRotation",
@ -187,7 +187,7 @@
{"shape":"KMSInvalidStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p>"
"documentation":"<p>Disables <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\">automatic rotation of the key material</a> for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"EnableKey":{
"name":"EnableKey",
@ -204,7 +204,7 @@
{"shape":"LimitExceededException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.</p>"
"documentation":"<p>Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"EnableKeyRotation":{
"name":"EnableKeyRotation",
@ -222,7 +222,7 @@
{"shape":"KMSInvalidStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p>"
"documentation":"<p>Enables <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\">automatic rotation of the key material</a> for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"Encrypt":{
"name":"Encrypt",
@ -242,7 +242,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Encrypts plaintext into ciphertext by using a customer master key (CMK). The <code>Encrypt</code> operation has two primary use cases:</p> <ul> <li> <p>You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.</p> </li> <li> <p>To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.</p> </li> </ul> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> <p>Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a generated data key within a region. To get data keys that are already encrypted, call the <a>GenerateDataKey</a> or <a>GenerateDataKeyWithoutPlaintext</a> operation. Data keys don't need to be encrypted again by calling <code>Encrypt</code>.</p> <p>To encrypt data locally in your application, use the <a>GenerateDataKey</a> operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.</p>"
"documentation":"<p>Encrypts plaintext into ciphertext by using a customer master key (CMK). The <code>Encrypt</code> operation has two primary use cases:</p> <ul> <li> <p>You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.</p> </li> <li> <p>You can use the <code>Encrypt</code> operation to move encrypted data from one AWS region to another. In the first region, generate a data key and use the plaintext key to encrypt the data. Then, in the new region, call the <code>Encrypt</code> method on same plaintext data key. Now, you can safely move the encrypted data and encrypted data key to the new region, and decrypt in the new region when necessary.</p> </li> </ul> <p>You don't need use this operation to encrypt a data key within a region. The <a>GenerateDataKey</a> and <a>GenerateDataKeyWithoutPlaintext</a> operations return an encrypted data key.</p> <p>Also, you don't need to use this operation to encrypt data in your application. You can use the plaintext and encrypted data keys that the <code>GenerateDataKey</code> operation returns.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p>"
},
"GenerateDataKey":{
"name":"GenerateDataKey",
@ -262,7 +262,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Returns a data encryption key that you can use in your application to encrypt data locally. </p> <p>You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the <code>KeySpec</code> or <code>NumberOfBytes</code> field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use <code>KeySpec</code>. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> <p>This operation returns a plaintext copy of the data key in the <code>Plaintext</code> field of the response, and an encrypted copy of the data key in the <code>CiphertextBlob</code> field. The data key is encrypted under the CMK specified in the <code>KeyId</code> field of the request. </p> <p>We recommend that you use the following pattern to encrypt data locally in your application:</p> <ol> <li> <p>Use this operation (<code>GenerateDataKey</code>) to get a data encryption key.</p> </li> <li> <p>Use the plaintext data encryption key (returned in the <code>Plaintext</code> field of the response) to encrypt data locally, then erase the plaintext data key from memory.</p> </li> <li> <p>Store the encrypted data key (returned in the <code>CiphertextBlob</code> field of the response) alongside the locally encrypted data.</p> </li> </ol> <p>To decrypt data locally:</p> <ol> <li> <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key into a plaintext copy of the data key.</p> </li> <li> <p>Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.</p> </li> </ol> <p>To return only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To return a random byte string that is cryptographically secure, use <a>GenerateRandom</a>.</p> <p>If you use the optional <code>EncryptionContext</code> field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the <a>Decrypt</a> operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Returns a data encryption key that you can use in your application to encrypt data locally. </p> <p>You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the <code>KeySpec</code> or <code>NumberOfBytes</code> field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use <code>KeySpec</code>. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> <p>This operation returns a plaintext copy of the data key in the <code>Plaintext</code> field of the response, and an encrypted copy of the data key in the <code>CiphertextBlob</code> field. The data key is encrypted under the CMK specified in the <code>KeyId</code> field of the request. </p> <p>We recommend that you use the following pattern to encrypt data locally in your application:</p> <ol> <li> <p>Use this operation (<code>GenerateDataKey</code>) to get a data encryption key.</p> </li> <li> <p>Use the plaintext data encryption key (returned in the <code>Plaintext</code> field of the response) to encrypt data locally, then erase the plaintext data key from memory.</p> </li> <li> <p>Store the encrypted data key (returned in the <code>CiphertextBlob</code> field of the response) alongside the locally encrypted data.</p> </li> </ol> <p>To decrypt data locally:</p> <ol> <li> <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key into a plaintext copy of the data key.</p> </li> <li> <p>Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.</p> </li> </ol> <p>To return only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To return a random byte string that is cryptographically secure, use <a>GenerateRandom</a>.</p> <p>If you use the optional <code>EncryptionContext</code> field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the <a>Decrypt</a> operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"GenerateDataKeyWithoutPlaintext":{
"name":"GenerateDataKeyWithoutPlaintext",
@ -282,7 +282,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to <a>GenerateDataKey</a> but returns only the encrypted copy of the data key. </p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> <p>This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the <i>control plane</i>, creates new containers. When it creates a new container, it uses this operation (<code>GenerateDataKeyWithoutPlaintext</code>) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the <i>data plane</i>, puts encrypted data into the containers. To do this, it passes the encrypted data key to the <a>Decrypt</a> operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.</p>"
"documentation":"<p>Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to <a>GenerateDataKey</a> but returns only the encrypted copy of the data key. </p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.</p> <p>This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the <i>control plane</i>, creates new containers. When it creates a new container, it uses this operation (<code>GenerateDataKeyWithoutPlaintext</code>) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the <i>data plane</i>, puts encrypted data into the containers. To do this, it passes the encrypted data key to the <a>Decrypt</a> operation. It then uses the returned plaintext data key to encrypt data and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"GenerateRandom":{
"name":"GenerateRandom",
@ -331,7 +331,7 @@
{"shape":"KMSInvalidStateException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.</p>"
"documentation":"<p>Gets a Boolean value that indicates whether <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\">automatic rotation of the key material</a> is enabled for the specified customer master key (CMK).</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <ul> <li> <p>Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.</p> </li> <li> <p>Pending deletion: While a CMK is pending deletion, its key rotation status is <code>false</code> and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.</p> </li> </ul> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p>"
},
"GetParametersForImport":{
"name":"GetParametersForImport",
@ -349,7 +349,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's <code>Origin</code> must be <code>EXTERNAL</code>. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a CMK in a different AWS account.</p> <p>This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request. The public key and import token from the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be used for a subsequent <a>ImportKeyMaterial</a> request. To get new ones, send another <code>GetParametersForImport</code> request.</p>"
"documentation":"<p>Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's <code>Origin</code> must be <code>EXTERNAL</code>. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a CMK in a different AWS account.</p> <p>This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request. The public key and import token from the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be used for a subsequent <a>ImportKeyMaterial</a> request. To get new ones, send another <code>GetParametersForImport</code> request.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"ImportKeyMaterial":{
"name":"ImportKeyMaterial",
@ -371,7 +371,7 @@
{"shape":"ExpiredImportTokenException"},
{"shape":"InvalidImportTokenException"}
],
"documentation":"<p>Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Before using this operation, call <a>GetParametersForImport</a>. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same <code>GetParametersForImport</code> response.</p> <p>When calling this operation, you must specify the following values:</p> <ul> <li> <p>The key ID or key ARN of a CMK with no key material. Its <code>Origin</code> must be <code>EXTERNAL</code>.</p> <p>To create a CMK with no key material, call <a>CreateKey</a> and set the value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the <code>Origin</code> of a CMK, call <a>DescribeKey</a>.)</p> </li> <li> <p>The encrypted key material. To get the public key to encrypt the key material, call <a>GetParametersForImport</a>.</p> </li> <li> <p>The import token that <a>GetParametersForImport</a> returned. This token and the public key used to encrypt the key material must have come from the same response.</p> </li> <li> <p>Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.</p> </li> </ul> <p>When this operation is successful, the CMK's key state changes from <code>PendingImport</code> to <code>Enabled</code>, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.</p>"
"documentation":"<p>Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Before using this operation, call <a>GetParametersForImport</a>. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same <code>GetParametersForImport</code> response.</p> <p>When calling this operation, you must specify the following values:</p> <ul> <li> <p>The key ID or key ARN of a CMK with no key material. Its <code>Origin</code> must be <code>EXTERNAL</code>.</p> <p>To create a CMK with no key material, call <a>CreateKey</a> and set the value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the <code>Origin</code> of a CMK, call <a>DescribeKey</a>.)</p> </li> <li> <p>The encrypted key material. To get the public key to encrypt the key material, call <a>GetParametersForImport</a>.</p> </li> <li> <p>The import token that <a>GetParametersForImport</a> returned. This token and the public key used to encrypt the key material must have come from the same response.</p> </li> <li> <p>Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.</p> </li> </ul> <p>When this operation is successful, the CMK's key state changes from <code>PendingImport</code> to <code>Enabled</code>, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"ListAliases":{
"name":"ListAliases",
@ -386,7 +386,7 @@
{"shape":"InvalidMarkerException"},
{"shape":"KMSInternalException"}
],
"documentation":"<p>Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see <a>CreateAlias</a>.</p> <p>The response might include several aliases that do not have a <code>TargetKeyId</code> field because they are not associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an alias is not associated with a CMK, the alias does not count against the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit\">alias limit</a> for your account.</p>"
"documentation":"<p>Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see <a>CreateAlias</a>.</p> <p>By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the <code>KeyId</code> parameter.</p> <p>The <code>ListAliases</code> response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format <code>aws/&lt;service-name&gt;</code>, such as <code>aws/dynamodb</code>.</p> <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit\">AWS KMS aliases limit</a>.</p>"
},
"ListGrants":{
"name":"ListGrants",
@ -404,7 +404,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Gets a list of all grants for the specified customer master key (CMK).</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.</p>"
"documentation":"<p>Gets a list of all grants for the specified customer master key (CMK).</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p>"
},
"ListKeyPolicies":{
"name":"ListKeyPolicies",
@ -509,7 +509,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext. </p> <p>You can reencrypt data using CMKs in different AWS accounts.</p> <p>Unlike other operations, <code>ReEncrypt</code> is authorized twice, once as <code>ReEncryptFrom</code> on the source CMK and once as <code>ReEncryptTo</code> on the destination CMK. We recommend that you include the <code>\"kms:ReEncrypt*\"</code> permission in your <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\">key policies</a> to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the <a>PutKeyPolicy</a> operation.</p>"
"documentation":"<p>Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext. </p> <p>You can reencrypt data using CMKs in different AWS accounts.</p> <p>Unlike other operations, <code>ReEncrypt</code> is authorized twice, once as <code>ReEncryptFrom</code> on the source CMK and once as <code>ReEncryptTo</code> on the destination CMK. We recommend that you include the <code>\"kms:ReEncrypt*\"</code> permission in your <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\">key policies</a> to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console. But you must include it manually when you create a CMK programmatically or when you set a key policy with the <a>PutKeyPolicy</a> operation.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"RetireGrant":{
"name":"RetireGrant",
@ -544,7 +544,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.</p>"
"documentation":"<p>Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.</p> <p>To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p>"
},
"ScheduleKeyDeletion":{
"name":"ScheduleKeyDeletion",
@ -561,7 +561,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.</p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> <important> <p>Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>.</p> </important> <p>For more information about scheduling a CMK for deletion, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.</p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> <important> <p>Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use <a>DisableKey</a>.</p> </important> <p>For more information about scheduling a CMK for deletion, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"TagResource":{
"name":"TagResource",
@ -578,7 +578,7 @@
{"shape":"LimitExceededException"},
{"shape":"TagException"}
],
"documentation":"<p>Adds or overwrites one or more tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.</p> <p>You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is <code>Purpose</code> and tag value is <code>Test</code>. If you send a <code>TagResource</code> request for this CMK with a tag key of <code>Purpose</code> and a tag value of <code>Prod</code>, it does not create a second tag. Instead, the original tag is overwritten with the new tag value.</p> <p>For information about the rules that apply to tag keys and tag values, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p>"
"documentation":"<p>Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.</p> <p>You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.</p> <p>For information about the rules that apply to tag keys and tag values, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -594,7 +594,7 @@
{"shape":"KMSInvalidStateException"},
{"shape":"TagException"}
],
"documentation":"<p>Removes the specified tag or tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use <a>TagResource</a>.</p>"
"documentation":"<p>Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.</p> <p>To remove a tag, specify the tag key. To change the tag value of an existing tag key, use <a>TagResource</a>.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"UpdateAlias":{
"name":"UpdateAlias",
@ -609,7 +609,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.</p> <p>This operation works only on existing aliases. To change the alias of a CMK to a new value, use <a>CreateAlias</a> to create a new alias and <a>DeleteAlias</a> to delete the old alias.</p> <p>Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs in the account, use the <a>ListAliases</a> operation. </p> <p>An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word <code>alias</code> followed by a forward slash (<code>alias/</code>). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with <code>aws</code>; that alias name prefix is reserved by Amazon Web Services (AWS).</p>"
"documentation":"<p>Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.</p> <p>This operation works only on existing aliases. To change the alias of a CMK to a new value, use <a>CreateAlias</a> to create a new alias and <a>DeleteAlias</a> to delete the old alias.</p> <p>Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs in the account, use the <a>ListAliases</a> operation. </p> <p>An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word <code>alias</code> followed by a forward slash (<code>alias/</code>). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with <code>aws</code>; that alias name prefix is reserved by Amazon Web Services (AWS).</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"UpdateKeyDescription":{
"name":"UpdateKeyDescription",
@ -625,7 +625,7 @@
{"shape":"KMSInternalException"},
{"shape":"KMSInvalidStateException"}
],
"documentation":"<p>Updates the description of a customer master key (CMK). To see the decription of a CMK, use <a>DescribeKey</a>. </p> <p>You cannot perform this operation on a CMK in a different AWS account.</p>"
"documentation":"<p>Updates the description of a customer master key (CMK). To see the description of a CMK, use <a>DescribeKey</a>. </p> <p>You cannot perform this operation on a CMK in a different AWS account.</p> <p>The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
},
"shapes":{
@ -713,7 +713,7 @@
"members":{
"AliasName":{
"shape":"AliasNameType",
"documentation":"<p>String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.</p>"
"documentation":"<p>Specifies the alias name. This value must begin with <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>. The alias name cannot begin with <code>aws/</code>. The <code>alias/aws/</code> prefix is reserved for AWS managed CMKs.</p>"
},
"TargetKeyId":{
"shape":"KeyIdType",
@ -755,7 +755,7 @@
},
"Name":{
"shape":"GrantNameType",
"documentation":"<p>A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.</p> <p>When this value is absent, all <code>CreateGrant</code> requests result in a new grant with a unique <code>GrantId</code> even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the <code>CreateGrant</code> request.</p> <p>When this value is present, you can retry a <code>CreateGrant</code> request with identical parameters; if the grant already exists, the original <code>GrantId</code> is returned without creating a new grant. Note that the returned grant token is unique with every <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned. All grant tokens obtained in this way can be used interchangeably.</p>"
"documentation":"<p>A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.</p> <p>When this value is absent, all <code>CreateGrant</code> requests result in a new grant with a unique <code>GrantId</code> even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the <code>CreateGrant</code> request.</p> <p>When this value is present, you can retry a <code>CreateGrant</code> request with identical parameters; if the grant already exists, the original <code>GrantId</code> is returned without creating a new grant. Note that the returned grant token is unique with every <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned. All grant tokens obtained in this way can be used interchangeably.</p>"
}
}
},
@ -777,7 +777,7 @@
"members":{
"Policy":{
"shape":"PolicyType",
"documentation":"<p>The key policy to attach to the CMK.</p> <p>If you provide a key policy, it must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>CreateKey</code> request to make a subsequent <a>PutKeyPolicy</a> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default Key Policy</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The key policy size limit is 32 kilobytes (32768 bytes).</p>"
"documentation":"<p>The key policy to attach to the CMK.</p> <p>If you provide a key policy, it must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>CreateKey</code> request to make a subsequent <a>PutKeyPolicy</a> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy. The reason for this is that the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default Key Policy</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>The key policy size limit is 32 kilobytes (32768 bytes).</p>"
},
"Description":{
"shape":"DescriptionType",
@ -884,7 +884,7 @@
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key (CMK).</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
"documentation":"<p>Describes the specified customer master key (CMK). </p> <p>If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">AWS managed CMK</a> and returns its <code>KeyId</code> and <code>Arn</code> in the response.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
@ -963,7 +963,7 @@
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key (CMK).</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
"documentation":"<p>A unique identifier for the customer master key (CMK).</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
},
"Plaintext":{
"shape":"PlaintextType",
@ -1021,7 +1021,7 @@
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The identifier of the CMK under which to generate and encrypt the data encryption key.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
"documentation":"<p>The identifier of the CMK under which to generate and encrypt the data encryption key.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
},
"EncryptionContext":{
"shape":"EncryptionContextType",
@ -1064,7 +1064,7 @@
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
"documentation":"<p>The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
},
"EncryptionContext":{
"shape":"EncryptionContextType",
@ -1174,7 +1174,7 @@
},
"WrappingAlgorithm":{
"shape":"AlgorithmSpec",
"documentation":"<p>The algorithm you will use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html\">Encrypt the Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>The algorithm you use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html\">Encrypt the Key Material</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"WrappingKeySpec":{
"shape":"WrappingKeySpec",
@ -1215,7 +1215,7 @@
"documentation":"<p>A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.</p>"
}
},
"documentation":"<p>A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Grant constraints apply only to operations that accept encryption context as input. For example, the <code> <a>DescribeKey</a> </code> operation does not accept encryption context as input. A grant that allows the <code>DescribeKey</code> operation does so regardless of the grant constraints. In constrast, the <code> <a>Encrypt</a> </code> operation accepts encryption context as input. A grant that allows the <code>Encrypt</code> operation does so only when the encryption context of the <code>Encrypt</code> operation satisfies the grant constraints.</p>"
"documentation":"<p>A structure that you can use to allow certain operations in the grant only when the preferred encryption context is present. For more information about encryption context, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encryption-context.html\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p> <p>Grant constraints apply only to operations that accept encryption context as input. For example, the <code> <a>DescribeKey</a> </code> operation does not accept encryption context as input. A grant that allows the <code>DescribeKey</code> operation does so regardless of the grant constraints. In contrast, the <code> <a>Encrypt</a> </code> operation accepts encryption context as input. A grant that allows the <code>Encrypt</code> operation does so only when the encryption context of the <code>Encrypt</code> operation satisfies the grant constraints.</p>"
},
"GrantIdType":{
"type":"string",
@ -1510,7 +1510,7 @@
},
"KeyManager":{
"shape":"KeyManagerType",
"documentation":"<p>The CMK's manager. CMKs are either customer-managed or AWS-managed. For more information about the difference, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
"documentation":"<p>The CMK's manager. CMKs are either customer managed or AWS managed. For more information about the difference, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>Contains metadata about a customer master key (CMK).</p> <p>This data type is used as a response element for the <a>CreateKey</a> and <a>DescribeKey</a> operations.</p>"
@ -1553,6 +1553,10 @@
"ListAliasesRequest":{
"type":"structure",
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.</p> <p>This parameter is optional. If you omit it, <code>ListAliases</code> returns all aliases in the account and region.</p>"
},
"Limit":{
"shape":"LimitType",
"documentation":"<p>Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>"
@ -1817,7 +1821,7 @@
},
"Policy":{
"shape":"PolicyType",
"documentation":"<p>The key policy to attach to the CMK.</p> <p>The key policy must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>PutKeyPolicy</code> request to make a subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>The key policy size limit is 32 kilobytes (32768 bytes).</p>"
"documentation":"<p>The key policy to attach to the CMK.</p> <p>The key policy must meet the following criteria:</p> <ul> <li> <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow the principal that is making the <code>PutKeyPolicy</code> request to make a subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam\">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy. The reason for this is that the new principal might not be immediately visible to AWS KMS. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency\">Changes that I make are not always immediately visible</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </li> </ul> <p>The key policy size limit is 32 kilobytes (32768 bytes).</p>"
},
"BypassPolicyLockoutSafetyCheck":{
"shape":"BooleanType",
@ -1842,7 +1846,7 @@
},
"DestinationKeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the CMK that is used to reencrypt the data.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
"documentation":"<p>A unique identifier for the CMK that is used to reencrypt the data.</p> <p>To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with <code>\"alias/\"</code>. To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.</p> <p>For example:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias ARN: <code>arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>"
},
"DestinationEncryptionContext":{
"shape":"EncryptionContextType",
@ -2057,5 +2061,5 @@
"enum":["RSA_2048"]
}
},
"documentation":"<fullname>AWS Key Management Service</fullname> <p>AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/\">AWS Key Management Service Developer Guide</a>.</p> <note> <p>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note> <p>We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.</p> <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.</p> <p> <b>Signing Requests</b> </p> <p>Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you <i>do not</i> use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.</p> <p>All AWS KMS operations require <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p> <p> <b>Logging API Requests</b> </p> <p>AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/\">AWS CloudTrail User Guide</a>.</p> <p> <b>Additional Resources</b> </p> <p>For more information about credentials and request signing, see the following:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html\">AWS Security Credentials</a> - This topic provides general information about the types of credentials used for accessing AWS.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html\">Temporary Security Credentials</a> - This section of the <i>IAM User Guide</i> describes how to create and use temporary security credentials.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.</p> </li> </ul> <p> <b>Commonly Used APIs</b> </p> <p>Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.</p> <ul> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> </ul>"
"documentation":"<fullname>AWS Key Management Service</fullname> <p>AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/\">AWS Key Management Service Developer Guide</a>.</p> <note> <p>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note> <p>We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.</p> <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.</p> <p> <b>Signing Requests</b> </p> <p>Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you <i>do not</i> use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.</p> <p>All AWS KMS operations require <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p> <p> <b>Logging API Requests</b> </p> <p>AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/\">AWS CloudTrail User Guide</a>.</p> <p> <b>Additional Resources</b> </p> <p>For more information about credentials and request signing, see the following:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html\">AWS Security Credentials</a> - This topic provides general information about the types of credentials used for accessing AWS.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html\">Temporary Security Credentials</a> - This section of the <i>IAM User Guide</i> describes how to create and use temporary security credentials.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.</p> </li> </ul> <p> <b>Commonly Used API Operations</b> </p> <p>Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.</p> <ul> <li> <p> <a>Encrypt</a> </p> </li> <li> <p> <a>Decrypt</a> </p> </li> <li> <p> <a>GenerateDataKey</a> </p> </li> <li> <p> <a>GenerateDataKeyWithoutPlaintext</a> </p> </li> </ul>"
}

35
botocore/data/logs/2014-03-28/service-2.json
View file

@ -397,9 +397,10 @@
{"shape":"InvalidSequenceTokenException"},
{"shape":"DataAlreadyAcceptedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceUnavailableException"}
{"shape":"ServiceUnavailableException"},
{"shape":"UnrecognizedClientException"}
],
"documentation":"<p>Uploads a batch of log events to the specified log stream.</p> <p>You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using <a>DescribeLogStreams</a>. If you call <code>PutLogEvents</code> twice within a narrow time period using the same value for <code>sequenceToken</code>, both calls may be successful, or one may be rejected.</p> <p>The batch of events must satisfy the following constraints:</p> <ul> <li> <p>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</p> </li> <li> <p>None of the log events in the batch can be more than 2 hours in the future.</p> </li> <li> <p>None of the log events in the batch can be older than 14 days or the retention period of the log group.</p> </li> <li> <p>The log events in the batch must be in chronological ordered by their time stamp (the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC).</p> </li> <li> <p>The maximum number of log events in a batch is 10,000.</p> </li> <li> <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p> </li> </ul>"
"documentation":"<p>Uploads a batch of log events to the specified log stream.</p> <p>You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using <a>DescribeLogStreams</a>. If you call <code>PutLogEvents</code> twice within a narrow time period using the same value for <code>sequenceToken</code>, both calls may be successful, or one may be rejected.</p> <p>The batch of events must satisfy the following constraints:</p> <ul> <li> <p>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</p> </li> <li> <p>None of the log events in the batch can be more than 2 hours in the future.</p> </li> <li> <p>None of the log events in the batch can be older than 14 days or the retention period of the log group.</p> </li> <li> <p>The log events in the batch must be in chronological ordered by their time stamp. The time stamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.) </p> </li> <li> <p>The maximum number of log events in a batch is 10,000.</p> </li> <li> <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p> </li> </ul> <p>If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key. </p>"
},
"PutMetricFilter":{
"name":"PutMetricFilter",
@ -430,7 +431,7 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 50 resource policies per region.</p>"
"documentation":"<p>Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region.</p>"
},
"PutRetentionPolicy":{
"name":"PutRetentionPolicy",
@ -823,7 +824,7 @@
},
"logStreamNamePrefix":{
"shape":"LogStreamName",
"documentation":"<p>The prefix to match.</p> <p>iIf <code>orderBy</code> is <code>LastEventTime</code>,you cannot specify this parameter.</p>"
"documentation":"<p>The prefix to match.</p> <p>If <code>orderBy</code> is <code>LastEventTime</code>,you cannot specify this parameter.</p>"
},
"orderBy":{
"shape":"OrderBy",
@ -872,10 +873,13 @@
"shape":"DescribeLimit",
"documentation":"<p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>"
},
"metricName":{"shape":"MetricName"},
"metricName":{
"shape":"MetricName",
"documentation":"<p>Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the <code>metricNamespace</code> parameter.</p>"
},
"metricNamespace":{
"shape":"MetricNamespace",
"documentation":"<p>The namespace of the CloudWatch metric.</p>"
"documentation":"<p>Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the <code>metricName</code> parameter.</p>"
}
}
},
@ -1236,11 +1240,11 @@
},
"startTime":{
"shape":"Timestamp",
"documentation":"<p>The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not included.</p>"
"documentation":"<p>The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.</p>"
},
"endTime":{
"shape":"Timestamp",
"documentation":"<p>The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not included.</p>"
"documentation":"<p>The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp equal to or later than this time are not included.</p>"
},
"nextToken":{
"shape":"NextToken",
@ -1265,11 +1269,11 @@
},
"nextForwardToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of items in the forward direction. The token expires after 24 hours.</p>"
"documentation":"<p>The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it will return the same token you passed in.</p>"
},
"nextBackwardToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of items in the backward direction. The token expires after 24 hours.</p>"
"documentation":"<p>The token for the next set of items in the backward direction. The token expires after 24 hours. This token will never be null. If you have reached the end of the stream, it will return the same token you passed in.</p>"
}
}
},
@ -1282,7 +1286,7 @@
"members":{
"timestamp":{
"shape":"Timestamp",
"documentation":"<p>The time the event occurred, expressed as the number of milliseconds fter Jan 1, 1970 00:00:00 UTC.</p>"
"documentation":"<p>The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>"
},
"message":{
"shape":"EventMessage",
@ -1715,7 +1719,7 @@
},
"policyDocument":{
"shape":"PolicyDocument",
"documentation":"<p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.</p> <p>The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.</p> <p> { \"Version\": \"2012-10-17\" \"Statement\": [ { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\":\"logs:PutLogEvents\", \"Resource\": logArn } ] } </p>"
"documentation":"<p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.</p> <p>The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.</p> <p> <code>{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\":\"logs:PutLogEvents\", \"Resource\": \"logArn\" } ] } </code> </p>"
}
}
},
@ -1980,6 +1984,13 @@
"min":0
},
"Token":{"type":"string"},
"UnrecognizedClientException":{
"type":"structure",
"members":{
},
"documentation":"<p>The most likely cause is an invalid AWS access key ID or secret key.</p>",
"exception":true
},
"UntagLogGroupRequest":{
"type":"structure",
"required":[

160
botocore/data/mediaconvert/2017-08-29/service-2.json
View file

@ -1954,6 +1954,11 @@
"locationName": "minBufferTime",
"documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout."
},
"MinFinalSegmentLength": {
"shape": "__doubleMin0Max2147483647",
"locationName": "minFinalSegmentLength",
"documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds."
},
"SegmentControl": {
"shape": "CmafSegmentControl",
"locationName": "segmentControl"
@ -3299,6 +3304,14 @@
"MAIN"
]
},
"H264DynamicSubGop": {
"type": "string",
"documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).",
"enum": [
"ADAPTIVE",
"STATIC"
]
},
"H264EntropyEncoding": {
"type": "string",
"documentation": "Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.",
@ -3383,12 +3396,32 @@
"MULTI_PASS_HQ"
]
},
"H264QvbrSettings": {
"type": "structure",
"members": {
"MaxAverageBitrate": {
"shape": "__integerMin1000Max1152000000",
"locationName": "maxAverageBitrate",
"documentation": "Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output."
},
"QvbrQualityLevel": {
"shape": "__integerMin1Max10",
"locationName": "qvbrQualityLevel",
"documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9."
}
},
"documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.",
"required": [
"QvbrQualityLevel"
]
},
"H264RateControlMode": {
"type": "string",
"documentation": "Use this setting to specify whether this output has a variable bitrate (VBR) or constant bitrate (CBR).",
"documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).",
"enum": [
"VBR",
"CBR"
"CBR",
"QVBR"
]
},
"H264RepeatPps": {
@ -3427,6 +3460,11 @@
"shape": "H264CodecProfile",
"locationName": "codecProfile"
},
"DynamicSubGop": {
"shape": "H264DynamicSubGop",
"locationName": "dynamicSubGop",
"documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames)."
},
"EntropyEncoding": {
"shape": "H264EntropyEncoding",
"locationName": "entropyEncoding"
@ -3492,7 +3530,7 @@
"MaxBitrate": {
"shape": "__integerMin1000Max1152000000",
"locationName": "maxBitrate",
"documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000."
"documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR."
},
"MinIInterval": {
"shape": "__integerMin0Max30",
@ -3527,6 +3565,11 @@
"shape": "H264QualityTuningLevel",
"locationName": "qualityTuningLevel"
},
"QvbrSettings": {
"shape": "H264QvbrSettings",
"locationName": "qvbrSettings",
"documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode."
},
"RateControlMode": {
"shape": "H264RateControlMode",
"locationName": "rateControlMode"
@ -3679,6 +3722,14 @@
"MAIN_422_10BIT_HIGH"
]
},
"H265DynamicSubGop": {
"type": "string",
"documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).",
"enum": [
"ADAPTIVE",
"STATIC"
]
},
"H265FlickerAdaptiveQuantization": {
"type": "string",
"documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.",
@ -3747,12 +3798,32 @@
"MULTI_PASS_HQ"
]
},
"H265QvbrSettings": {
"type": "structure",
"members": {
"MaxAverageBitrate": {
"shape": "__integerMin1000Max1466400000",
"locationName": "maxAverageBitrate",
"documentation": "Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output."
},
"QvbrQualityLevel": {
"shape": "__integerMin1Max10",
"locationName": "qvbrQualityLevel",
"documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9."
}
},
"documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.",
"required": [
"QvbrQualityLevel"
]
},
"H265RateControlMode": {
"type": "string",
"documentation": "Use this setting to specify whether this output has a variable bitrate (VBR) or constant bitrate (CBR).",
"documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).",
"enum": [
"VBR",
"CBR"
"CBR",
"QVBR"
]
},
"H265SampleAdaptiveOffsetFilterMode": {
@ -3796,6 +3867,11 @@
"shape": "H265CodecProfile",
"locationName": "codecProfile"
},
"DynamicSubGop": {
"shape": "H265DynamicSubGop",
"locationName": "dynamicSubGop",
"documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames)."
},
"FlickerAdaptiveQuantization": {
"shape": "H265FlickerAdaptiveQuantization",
"locationName": "flickerAdaptiveQuantization"
@ -3853,7 +3929,7 @@
"MaxBitrate": {
"shape": "__integerMin1000Max1466400000",
"locationName": "maxBitrate",
"documentation": "Maximum bitrate in bits/second."
"documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR."
},
"MinIInterval": {
"shape": "__integerMin0Max30",
@ -3888,6 +3964,11 @@
"shape": "H265QualityTuningLevel",
"locationName": "qualityTuningLevel"
},
"QvbrSettings": {
"shape": "H265QvbrSettings",
"locationName": "qvbrSettings",
"documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode."
},
"RateControlMode": {
"shape": "H265RateControlMode",
"locationName": "rateControlMode"
@ -4244,6 +4325,11 @@
"shape": "HlsManifestDurationFormat",
"locationName": "manifestDurationFormat"
},
"MinFinalSegmentLength": {
"shape": "__doubleMin0Max2147483647",
"locationName": "minFinalSegmentLength",
"documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds."
},
"MinSegmentLength": {
"shape": "__integerMin0Max2147483647",
"locationName": "minSegmentLength",
@ -4722,7 +4808,7 @@
"documentation": "An identifier for this resource that is unique within all of AWS."
},
"CreatedAt": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "createdAt",
"documentation": "The time, in Unix epoch format in seconds, when the job got created."
},
@ -4853,7 +4939,7 @@
"documentation": "An optional category you create to organize your job templates."
},
"CreatedAt": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "createdAt",
"documentation": "The timestamp in epoch seconds for Job template creation."
},
@ -4863,7 +4949,7 @@
"documentation": "An optional description you create for each job template."
},
"LastUpdated": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "lastUpdated",
"documentation": "The timestamp in epoch seconds when the Job template was last updated."
},
@ -5873,6 +5959,14 @@
"PROFILE_422"
]
},
"Mpeg2DynamicSubGop": {
"type": "string",
"documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).",
"enum": [
"ADAPTIVE",
"STATIC"
]
},
"Mpeg2FramerateControl": {
"type": "string",
"documentation": "If you are using the console, use the Framerate setting to specify the framerate for this output. If you want to keep the same framerate as the input video, choose Follow source. If you want to do framerate conversion, choose a framerate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your framerate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the framerate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the framerate from the input. Choose SPECIFIED if you want the service to use the framerate you specify in the settings FramerateNumerator and FramerateDenominator.",
@ -5971,6 +6065,11 @@
"shape": "Mpeg2CodecProfile",
"locationName": "codecProfile"
},
"DynamicSubGop": {
"shape": "Mpeg2DynamicSubGop",
"locationName": "dynamicSubGop",
"documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames)."
},
"FramerateControl": {
"shape": "Mpeg2FramerateControl",
"locationName": "framerateControl"
@ -6486,7 +6585,7 @@
"documentation": "An optional category you create to organize your presets."
},
"CreatedAt": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "createdAt",
"documentation": "The timestamp in epoch seconds for preset creation."
},
@ -6496,7 +6595,7 @@
"documentation": "An optional description you create for each preset."
},
"LastUpdated": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "lastUpdated",
"documentation": "The timestamp in epoch seconds when the preset was last updated."
},
@ -6679,7 +6778,7 @@
"documentation": "An identifier for this resource that is unique within all of AWS."
},
"CreatedAt": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "createdAt",
"documentation": "The timestamp in epoch seconds for queue creation."
},
@ -6689,7 +6788,7 @@
"documentation": "An optional description you create for each queue."
},
"LastUpdated": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "lastUpdated",
"documentation": "The timestamp in epoch seconds when the queue was last updated."
},
@ -6743,24 +6842,24 @@
"type": "structure",
"members": {
"Height": {
"shape": "__integerMinNegative2147483648Max2147483647",
"shape": "__integerMin2Max2147483647",
"locationName": "height",
"documentation": "Height of rectangle in pixels."
"documentation": "Height of rectangle in pixels. Specify only even numbers."
},
"Width": {
"shape": "__integerMinNegative2147483648Max2147483647",
"shape": "__integerMin2Max2147483647",
"locationName": "width",
"documentation": "Width of rectangle in pixels."
"documentation": "Width of rectangle in pixels. Specify only even numbers."
},
"X": {
"shape": "__integerMinNegative2147483648Max2147483647",
"shape": "__integerMin0Max2147483647",
"locationName": "x",
"documentation": "The distance, in pixels, between the rectangle and the left edge of the video frame."
"documentation": "The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers."
},
"Y": {
"shape": "__integerMinNegative2147483648Max2147483647",
"shape": "__integerMin0Max2147483647",
"locationName": "y",
"documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame."
"documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers."
}
},
"documentation": "Use Rectangle to identify a specific area of the video frame.",
@ -7046,17 +7145,17 @@
"type": "structure",
"members": {
"FinishTime": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "finishTime",
"documentation": "The time, in Unix epoch format, that the transcoding job finished"
},
"StartTime": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "startTime",
"documentation": "The time, in Unix epoch format, that transcoding for the job began."
},
"SubmitTime": {
"shape": "__timestampIso8601",
"shape": "__timestampUnix",
"locationName": "submitTime",
"documentation": "The time, in Unix epoch format, that you submitted the job."
}
@ -7478,6 +7577,9 @@
"__doubleMin0": {
"type": "double"
},
"__doubleMin0Max2147483647": {
"type": "double"
},
"__doubleMinNegative59Max0": {
"type": "double"
},
@ -7645,6 +7747,11 @@
"min": 1,
"max": 1
},
"__integerMin1Max10": {
"type": "integer",
"min": 1,
"max": 10
},
"__integerMin1Max100": {
"type": "integer",
"min": 1,
@ -7720,6 +7827,11 @@
"min": 25,
"max": 2000
},
"__integerMin2Max2147483647": {
"type": "integer",
"min": 2,
"max": 2147483647
},
"__integerMin32000Max384000": {
"type": "integer",
"min": 32000,

17
botocore/data/mediapackage/2017-10-12/service-2.json
View file

@ -776,6 +776,11 @@
"locationName": "minUpdatePeriodSeconds",
"shape": "__integer"
},
"PeriodTriggers": {
"documentation": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)\nMedia Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not\nbe partitioned into more than one period. If the list contains \"ADS\", new periods will be created where\nthe Channel source contains SCTE-35 ad markers.\n",
"locationName": "periodTriggers",
"shape": "__listOf__PeriodTriggersElement"
},
"Profile": {
"documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.",
"locationName": "profile",
@ -1833,6 +1838,12 @@
},
"type": "structure"
},
"__PeriodTriggersElement": {
"enum": [
"ADS"
],
"type": "string"
},
"__boolean": {
"type": "boolean"
},
@ -1872,6 +1883,12 @@
},
"type": "list"
},
"__listOf__PeriodTriggersElement": {
"member": {
"shape": "__PeriodTriggersElement"
},
"type": "list"
},
"__listOf__string": {
"member": {
"shape": "__string"

3
botocore/data/mq/2017-11-27/paginators-1.json Normal file
View file

@ -0,0 +1,3 @@
{
"pagination": {}
}

459
botocore/data/mq/2017-11-27/service-2.json
View file

@ -28,12 +28,12 @@
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it."
}, {
"shape" : "InternalServerErrorException",
"documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue."
}, {
"shape" : "UnauthorizedException",
"documentation" : "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated."
}, {
"shape" : "InternalServerErrorException",
"documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue."
}, {
"shape" : "ConflictException",
"documentation" : "HTTP Status Code 409: Conflict. This Broker name already exists. Retry your request with another name."
@ -70,7 +70,7 @@
"shape" : "ForbiddenException",
"documentation" : "HTTP Status Code 403: Access forbidden. Correct your input and then retry your request."
} ],
"documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration."
"documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version)."
},
"CreateUser" : {
"name" : "CreateUser",
@ -518,12 +518,12 @@
"ErrorAttribute" : {
"shape" : "__string",
"locationName" : "errorAttribute",
"documentation" : "The error attribute."
"documentation" : "The attribute which caused the error."
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "The error message."
"documentation" : "The explanation of the error."
}
},
"documentation" : "Returns information about an error.",
@ -541,16 +541,21 @@
"documentation" : "The URL of the broker's ActiveMQ Web Console."
},
"Endpoints" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "endpoints",
"documentation" : "The broker's wire-level protocol endpoints."
},
"IpAddress" : {
"shape" : "__string",
"locationName" : "ipAddress",
"documentation" : "The IP address of the ENI attached to the broker."
}
},
"documentation" : "Returns information about all brokers."
},
"BrokerState" : {
"type" : "string",
"documentation" : "The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS",
"documentation" : "The status of the broker.",
"enum" : [ "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS" ]
},
"BrokerSummary" : {
@ -574,24 +579,29 @@
"BrokerState" : {
"shape" : "BrokerState",
"locationName" : "brokerState",
"documentation" : "The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS"
"documentation" : "The status of the broker."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "The time when the broker was created."
},
"DeploymentMode" : {
"shape" : "DeploymentMode",
"locationName" : "deploymentMode",
"documentation" : "Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability."
"documentation" : "Required. The deployment mode of the broker."
},
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "The broker's instance type. Possible values: mq.t2.micro, mq.m4.large"
"documentation" : "The broker's instance type."
}
},
"documentation" : "The Amazon Resource Name (ARN) of the broker."
},
"ChangeType" : {
"type" : "string",
"documentation" : "The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE",
"documentation" : "The type of change pending for the ActiveMQ user.",
"enum" : [ "CREATE", "UPDATE", "DELETE" ]
},
"Configuration" : {
@ -602,6 +612,11 @@
"locationName" : "arn",
"documentation" : "Required. The ARN of the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration revision."
},
"Description" : {
"shape" : "__string",
"locationName" : "description",
@ -646,7 +661,7 @@
"Revision" : {
"shape" : "__integer",
"locationName" : "revision",
"documentation" : "The Universally Unique Identifier (UUID) of the request."
"documentation" : "The revision number of the configuration."
}
},
"documentation" : "A list of information about the configuration."
@ -654,6 +669,11 @@
"ConfigurationRevision" : {
"type" : "structure",
"members" : {
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration revision."
},
"Description" : {
"shape" : "__string",
"locationName" : "description",
@ -662,7 +682,7 @@
"Revision" : {
"shape" : "__integer",
"locationName" : "revision",
"documentation" : "Required. The revision of the configuration."
"documentation" : "Required. The revision number of the configuration."
}
},
"documentation" : "Returns information about the specified configuration revision."
@ -676,7 +696,7 @@
"documentation" : "The current configuration of the broker."
},
"History" : {
"shape" : "ListOfConfigurationId",
"shape" : "__listOfConfigurationId",
"locationName" : "history",
"documentation" : "The history of configurations applied to the broker."
},
@ -694,12 +714,12 @@
"ErrorAttribute" : {
"shape" : "__string",
"locationName" : "errorAttribute",
"documentation" : "The error attribute."
"documentation" : "The attribute which caused the error."
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "The error message."
"documentation" : "The explanation of the error."
}
},
"documentation" : "Returns information about an error.",
@ -735,7 +755,7 @@
"DeploymentMode" : {
"shape" : "DeploymentMode",
"locationName" : "deploymentMode",
"documentation" : "Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability."
"documentation" : "Required. The deployment mode of the broker."
},
"EngineType" : {
"shape" : "EngineType",
@ -750,7 +770,12 @@
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "Required. The broker's instance type. Possible values: mq.t2.micro, mq.m4.large"
"documentation" : "Required. The broker's instance type."
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "Enables Amazon CloudWatch logging for brokers."
},
"MaintenanceWindowStartTime" : {
"shape" : "WeeklyStartTime",
@ -763,17 +788,17 @@
"documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets."
},
"SecurityGroups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
"documentation" : "The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "subnetIds",
"documentation" : "Required. The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets."
"documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets."
},
"Users" : {
"shape" : "ListOfUser",
"shape" : "__listOfUser",
"locationName" : "users",
"documentation" : "Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
}
@ -823,7 +848,7 @@
"DeploymentMode" : {
"shape" : "DeploymentMode",
"locationName" : "deploymentMode",
"documentation" : "Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability."
"documentation" : "Required. The deployment mode of the broker."
},
"EngineType" : {
"shape" : "EngineType",
@ -838,7 +863,12 @@
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "Required. The broker's instance type. Possible values: mq.t2.micro, mq.m4.large"
"documentation" : "Required. The broker's instance type."
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "Enables Amazon CloudWatch logging for brokers."
},
"MaintenanceWindowStartTime" : {
"shape" : "WeeklyStartTime",
@ -851,17 +881,17 @@
"documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets."
},
"SecurityGroups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
"documentation" : "The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "subnetIds",
"documentation" : "Required. The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets."
"documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets."
},
"Users" : {
"shape" : "ListOfUser",
"shape" : "__listOfUser",
"locationName" : "users",
"documentation" : "Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
}
@ -902,7 +932,7 @@
"documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long."
}
},
"documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration."
"documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version)."
},
"CreateConfigurationOutput" : {
"type" : "structure",
@ -912,6 +942,11 @@
"locationName" : "arn",
"documentation" : "Required. The Amazon Resource Name (ARN) of the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration."
},
"Id" : {
"shape" : "__string",
"locationName" : "id",
@ -949,7 +984,7 @@
"documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long."
}
},
"documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version). Note: If the configuration name already exists, Amazon MQ doesn't create a configuration."
"documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version)."
},
"CreateConfigurationResponse" : {
"type" : "structure",
@ -959,6 +994,11 @@
"locationName" : "arn",
"documentation" : "Required. The Amazon Resource Name (ARN) of the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration."
},
"Id" : {
"shape" : "__string",
"locationName" : "id",
@ -985,7 +1025,7 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
@ -1012,7 +1052,7 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
@ -1096,7 +1136,7 @@
},
"DeploymentMode" : {
"type" : "string",
"documentation" : "The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.",
"documentation" : "The deployment mode of the broker.",
"enum" : [ "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ" ]
},
"DescribeBrokerOutput" : {
@ -1118,7 +1158,7 @@
"documentation" : "The unique ID that Amazon MQ generates for the broker."
},
"BrokerInstances" : {
"shape" : "ListOfBrokerInstance",
"shape" : "__listOfBrokerInstance",
"locationName" : "brokerInstances",
"documentation" : "A list of information about allocated brokers."
},
@ -1130,17 +1170,22 @@
"BrokerState" : {
"shape" : "BrokerState",
"locationName" : "brokerState",
"documentation" : "The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS"
"documentation" : "The status of the broker."
},
"Configurations" : {
"shape" : "Configurations",
"locationName" : "configurations",
"documentation" : "The list of all revisions for the specified configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "The time when the broker was created."
},
"DeploymentMode" : {
"shape" : "DeploymentMode",
"locationName" : "deploymentMode",
"documentation" : "Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability."
"documentation" : "Required. The deployment mode of the broker."
},
"EngineType" : {
"shape" : "EngineType",
@ -1155,7 +1200,12 @@
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "The broker's instance type. Possible values: mq.t2.micro, mq.m4.large"
"documentation" : "The broker's instance type."
},
"Logs" : {
"shape" : "LogsSummary",
"locationName" : "logs",
"documentation" : "The list of information about logs currently enabled and pending to be deployed for the specified broker."
},
"MaintenanceWindowStartTime" : {
"shape" : "WeeklyStartTime",
@ -1168,17 +1218,17 @@
"documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets."
},
"SecurityGroups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "subnetIds",
"documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets."
},
"Users" : {
"shape" : "ListOfUserSummary",
"shape" : "__listOfUserSummary",
"locationName" : "users",
"documentation" : "The list of all ActiveMQ usernames for the specified broker."
}
@ -1216,7 +1266,7 @@
"documentation" : "The unique ID that Amazon MQ generates for the broker."
},
"BrokerInstances" : {
"shape" : "ListOfBrokerInstance",
"shape" : "__listOfBrokerInstance",
"locationName" : "brokerInstances",
"documentation" : "A list of information about allocated brokers."
},
@ -1228,17 +1278,22 @@
"BrokerState" : {
"shape" : "BrokerState",
"locationName" : "brokerState",
"documentation" : "The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS"
"documentation" : "The status of the broker."
},
"Configurations" : {
"shape" : "Configurations",
"locationName" : "configurations",
"documentation" : "The list of all revisions for the specified configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "The time when the broker was created."
},
"DeploymentMode" : {
"shape" : "DeploymentMode",
"locationName" : "deploymentMode",
"documentation" : "Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability."
"documentation" : "Required. The deployment mode of the broker."
},
"EngineType" : {
"shape" : "EngineType",
@ -1253,7 +1308,12 @@
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "The broker's instance type. Possible values: mq.t2.micro, mq.m4.large"
"documentation" : "The broker's instance type."
},
"Logs" : {
"shape" : "LogsSummary",
"locationName" : "logs",
"documentation" : "The list of information about logs currently enabled and pending to be deployed for the specified broker."
},
"MaintenanceWindowStartTime" : {
"shape" : "WeeklyStartTime",
@ -1266,17 +1326,17 @@
"documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets."
},
"SecurityGroups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "subnetIds",
"documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets."
},
"Users" : {
"shape" : "ListOfUserSummary",
"shape" : "__listOfUserSummary",
"locationName" : "users",
"documentation" : "The list of all ActiveMQ usernames for the specified broker."
}
@ -1302,6 +1362,11 @@
"locationName" : "arn",
"documentation" : "Required. The ARN of the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration revision."
},
"Description" : {
"shape" : "__string",
"locationName" : "description",
@ -1342,6 +1407,11 @@
"locationName" : "configurationId",
"documentation" : "Required. The unique ID that Amazon MQ generates for the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration."
},
"Data" : {
"shape" : "__string",
"locationName" : "data",
@ -1381,6 +1451,11 @@
"locationName" : "configurationId",
"documentation" : "Required. The unique ID that Amazon MQ generates for the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration."
},
"Data" : {
"shape" : "__string",
"locationName" : "data",
@ -1407,7 +1482,7 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
@ -1456,7 +1531,7 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
@ -1483,12 +1558,12 @@
"ErrorAttribute" : {
"shape" : "__string",
"locationName" : "errorAttribute",
"documentation" : "The error attribute."
"documentation" : "The attribute which caused the error."
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "The error message."
"documentation" : "The explanation of the error."
}
},
"documentation" : "Returns information about an error."
@ -1499,12 +1574,12 @@
"ErrorAttribute" : {
"shape" : "__string",
"locationName" : "errorAttribute",
"documentation" : "The error attribute."
"documentation" : "The attribute which caused the error."
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "The error message."
"documentation" : "The explanation of the error."
}
},
"documentation" : "Returns information about an error.",
@ -1519,12 +1594,12 @@
"ErrorAttribute" : {
"shape" : "__string",
"locationName" : "errorAttribute",
"documentation" : "The error attribute."
"documentation" : "The attribute which caused the error."
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "The error message."
"documentation" : "The explanation of the error."
}
},
"documentation" : "Returns information about an error.",
@ -1537,7 +1612,7 @@
"type" : "structure",
"members" : {
"BrokerSummaries" : {
"shape" : "ListOfBrokerSummary",
"shape" : "__listOfBrokerSummary",
"locationName" : "brokerSummaries",
"documentation" : "A list of information about all brokers."
},
@ -1570,7 +1645,7 @@
"type" : "structure",
"members" : {
"BrokerSummaries" : {
"shape" : "ListOfBrokerSummary",
"shape" : "__listOfBrokerSummary",
"locationName" : "brokerSummaries",
"documentation" : "A list of information about all brokers."
},
@ -1600,7 +1675,7 @@
"documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty."
},
"Revisions" : {
"shape" : "ListOfConfigurationRevision",
"shape" : "__listOfConfigurationRevision",
"locationName" : "revisions",
"documentation" : "The list of all revisions for the specified configuration."
}
@ -1650,7 +1725,7 @@
"documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty."
},
"Revisions" : {
"shape" : "ListOfConfigurationRevision",
"shape" : "__listOfConfigurationRevision",
"locationName" : "revisions",
"documentation" : "The list of all revisions for the specified configuration."
}
@ -1660,7 +1735,7 @@
"type" : "structure",
"members" : {
"Configurations" : {
"shape" : "ListOfConfiguration",
"shape" : "__listOfConfiguration",
"locationName" : "configurations",
"documentation" : "The list of all revisions for the specified configuration."
},
@ -1698,7 +1773,7 @@
"type" : "structure",
"members" : {
"Configurations" : {
"shape" : "ListOfConfiguration",
"shape" : "__listOfConfiguration",
"locationName" : "configurations",
"documentation" : "The list of all revisions for the specified configuration."
},
@ -1714,60 +1789,6 @@
}
}
},
"ListOfBrokerInstance" : {
"type" : "list",
"member" : {
"shape" : "BrokerInstance"
}
},
"ListOfBrokerSummary" : {
"type" : "list",
"member" : {
"shape" : "BrokerSummary"
}
},
"ListOfConfiguration" : {
"type" : "list",
"member" : {
"shape" : "Configuration"
}
},
"ListOfConfigurationId" : {
"type" : "list",
"member" : {
"shape" : "ConfigurationId"
}
},
"ListOfConfigurationRevision" : {
"type" : "list",
"member" : {
"shape" : "ConfigurationRevision"
}
},
"ListOfSanitizationWarning" : {
"type" : "list",
"member" : {
"shape" : "SanitizationWarning"
}
},
"ListOfUser" : {
"type" : "list",
"member" : {
"shape" : "User"
}
},
"ListOfUserSummary" : {
"type" : "list",
"member" : {
"shape" : "UserSummary"
}
},
"ListOf__string" : {
"type" : "list",
"member" : {
"shape" : "__string"
}
},
"ListUsersOutput" : {
"type" : "structure",
"members" : {
@ -1777,7 +1798,7 @@
"documentation" : "Required. The unique ID that Amazon MQ generates for the broker."
},
"MaxResults" : {
"shape" : "__integer",
"shape" : "__integerMin5Max100",
"locationName" : "maxResults",
"documentation" : "Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100."
},
@ -1787,7 +1808,7 @@
"documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty."
},
"Users" : {
"shape" : "ListOfUserSummary",
"shape" : "__listOfUserSummary",
"locationName" : "users",
"documentation" : "Required. The list of all ActiveMQ usernames for the specified broker."
}
@ -1827,7 +1848,7 @@
"documentation" : "Required. The unique ID that Amazon MQ generates for the broker."
},
"MaxResults" : {
"shape" : "__integer",
"shape" : "__integerMin5Max100",
"locationName" : "maxResults",
"documentation" : "Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100."
},
@ -1837,12 +1858,59 @@
"documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty."
},
"Users" : {
"shape" : "ListOfUserSummary",
"shape" : "__listOfUserSummary",
"locationName" : "users",
"documentation" : "Required. The list of all ActiveMQ usernames for the specified broker."
}
}
},
"Logs" : {
"type" : "structure",
"members" : {
"Audit" : {
"shape" : "__boolean",
"locationName" : "audit",
"documentation" : "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged."
},
"General" : {
"shape" : "__boolean",
"locationName" : "general",
"documentation" : "Enables general logging."
}
},
"documentation" : "The list of information about logs to be enabled for the specified broker."
},
"LogsSummary" : {
"type" : "structure",
"members" : {
"Audit" : {
"shape" : "__boolean",
"locationName" : "audit",
"documentation" : "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged."
},
"AuditLogGroup" : {
"shape" : "__string",
"locationName" : "auditLogGroup",
"documentation" : "Location of CloudWatch Log group where audit logs will be sent."
},
"General" : {
"shape" : "__boolean",
"locationName" : "general",
"documentation" : "Enables general logging."
},
"GeneralLogGroup" : {
"shape" : "__string",
"locationName" : "generalLogGroup",
"documentation" : "Location of CloudWatch Log group where general logs will be sent."
},
"Pending" : {
"shape" : "PendingLogs",
"locationName" : "pending",
"documentation" : "The list of information about logs pending to be deployed for the specified broker."
}
},
"documentation" : "The list of information about logs currently enabled and pending to be deployed for the specified broker."
},
"MaxResults" : {
"type" : "integer",
"min" : 1,
@ -1854,12 +1922,12 @@
"ErrorAttribute" : {
"shape" : "__string",
"locationName" : "errorAttribute",
"documentation" : "The error attribute."
"documentation" : "The attribute which caused the error."
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "The error message."
"documentation" : "The explanation of the error."
}
},
"documentation" : "Returns information about an error.",
@ -1868,6 +1936,22 @@
"httpStatusCode" : 404
}
},
"PendingLogs" : {
"type" : "structure",
"members" : {
"Audit" : {
"shape" : "__boolean",
"locationName" : "audit",
"documentation" : "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged."
},
"General" : {
"shape" : "__boolean",
"locationName" : "general",
"documentation" : "Enables general logging."
}
},
"documentation" : "The list of information about logs to be enabled for the specified broker."
},
"RebootBrokerRequest" : {
"type" : "structure",
"members" : {
@ -1900,14 +1984,14 @@
"Reason" : {
"shape" : "SanitizationWarningReason",
"locationName" : "reason",
"documentation" : "Required. The reason for which the XML elements or attributes were sanitized. Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed."
"documentation" : "Required. The reason for which the XML elements or attributes were sanitized."
}
},
"documentation" : "Returns information about the XML element or attribute that was sanitized in the configuration."
},
"SanitizationWarningReason" : {
"type" : "string",
"documentation" : "The reason for which the XML elements or attributes were sanitized. Possible values: DISALLOWED_ELEMENT_REMOVED, DISALLOWED_ATTRIBUTE_REMOVED, INVALID_ATTRIBUTE_VALUE_REMOVED DISALLOWED_ELEMENT_REMOVED shows that the provided element isn't allowed and has been removed. DISALLOWED_ATTRIBUTE_REMOVED shows that the provided attribute isn't allowed and has been removed. INVALID_ATTRIBUTE_VALUE_REMOVED shows that the provided value for the attribute isn't allowed and has been removed.",
"documentation" : "The reason for which the XML elements or attributes were sanitized.",
"enum" : [ "DISALLOWED_ELEMENT_REMOVED", "DISALLOWED_ATTRIBUTE_REMOVED", "INVALID_ATTRIBUTE_VALUE_REMOVED" ]
},
"UnauthorizedException" : {
@ -1916,12 +2000,12 @@
"ErrorAttribute" : {
"shape" : "__string",
"locationName" : "errorAttribute",
"documentation" : "The error attribute."
"documentation" : "The attribute which caused the error."
},
"Message" : {
"shape" : "__string",
"locationName" : "message",
"documentation" : "The error message."
"documentation" : "The explanation of the error."
}
},
"documentation" : "Returns information about an error.",
@ -1937,6 +2021,11 @@
"shape" : "ConfigurationId",
"locationName" : "configuration",
"documentation" : "A list of information about the configuration."
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "Enables Amazon CloudWatch logging for brokers."
}
},
"documentation" : "Updates the broker using the specified properties."
@ -1953,6 +2042,11 @@
"shape" : "ConfigurationId",
"locationName" : "configuration",
"documentation" : "The ID of the updated configuration."
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "The list of information about logs to be enabled for the specified broker."
}
},
"documentation" : "Returns information about the updated broker."
@ -1970,6 +2064,11 @@
"shape" : "ConfigurationId",
"locationName" : "configuration",
"documentation" : "A list of information about the configuration."
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "Enables Amazon CloudWatch logging for brokers."
}
},
"documentation" : "Updates the broker using the specified properties.",
@ -1987,6 +2086,11 @@
"shape" : "ConfigurationId",
"locationName" : "configuration",
"documentation" : "The ID of the updated configuration."
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "The list of information about logs to be enabled for the specified broker."
}
}
},
@ -2014,6 +2118,11 @@
"locationName" : "arn",
"documentation" : "Required. The Amazon Resource Name (ARN) of the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration."
},
"Id" : {
"shape" : "__string",
"locationName" : "id",
@ -2030,7 +2139,7 @@
"documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long."
},
"Warnings" : {
"shape" : "ListOfSanitizationWarning",
"shape" : "__listOfSanitizationWarning",
"locationName" : "warnings",
"documentation" : "The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized."
}
@ -2068,6 +2177,11 @@
"locationName" : "arn",
"documentation" : "Required. The Amazon Resource Name (ARN) of the configuration."
},
"Created" : {
"shape" : "__timestampIso8601",
"locationName" : "created",
"documentation" : "Required. The date and time of the configuration."
},
"Id" : {
"shape" : "__string",
"locationName" : "id",
@ -2084,7 +2198,7 @@
"documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long."
},
"Warnings" : {
"shape" : "ListOfSanitizationWarning",
"shape" : "__listOfSanitizationWarning",
"locationName" : "warnings",
"documentation" : "The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized."
}
@ -2099,7 +2213,7 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
@ -2126,7 +2240,7 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
@ -2158,7 +2272,7 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
@ -2184,14 +2298,14 @@
"documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user."
},
"Groups" : {
"shape" : "ListOf__string",
"shape" : "__listOf__string",
"locationName" : "groups",
"documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long."
},
"PendingChange" : {
"shape" : "ChangeType",
"locationName" : "pendingChange",
"documentation" : "Required. The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE"
"documentation" : "Required. The type of change pending for the ActiveMQ user."
}
},
"documentation" : "Returns information about the status of the changes pending for the ActiveMQ user."
@ -2202,7 +2316,7 @@
"PendingChange" : {
"shape" : "ChangeType",
"locationName" : "pendingChange",
"documentation" : "The type of change pending for the ActiveMQ user. Possible values: CREATE, UPDATE, DELETE"
"documentation" : "The type of change pending for the ActiveMQ user."
},
"Username" : {
"shape" : "__string",
@ -2218,7 +2332,7 @@
"DayOfWeek" : {
"shape" : "DayOfWeek",
"locationName" : "dayOfWeek",
"documentation" : "Required. The day of the week. Possible values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY"
"documentation" : "Required. The day of the week."
},
"TimeOfDay" : {
"shape" : "__string",
@ -2242,11 +2356,78 @@
"__integer" : {
"type" : "integer"
},
"__integerMin5Max100" : {
"type" : "integer",
"min" : 5,
"max" : 100
},
"__listOfBrokerInstance" : {
"type" : "list",
"member" : {
"shape" : "BrokerInstance"
}
},
"__listOfBrokerSummary" : {
"type" : "list",
"member" : {
"shape" : "BrokerSummary"
}
},
"__listOfConfiguration" : {
"type" : "list",
"member" : {
"shape" : "Configuration"
}
},
"__listOfConfigurationId" : {
"type" : "list",
"member" : {
"shape" : "ConfigurationId"
}
},
"__listOfConfigurationRevision" : {
"type" : "list",
"member" : {
"shape" : "ConfigurationRevision"
}
},
"__listOfSanitizationWarning" : {
"type" : "list",
"member" : {
"shape" : "SanitizationWarning"
}
},
"__listOfUser" : {
"type" : "list",
"member" : {
"shape" : "User"
}
},
"__listOfUserSummary" : {
"type" : "list",
"member" : {
"shape" : "UserSummary"
}
},
"__listOf__string" : {
"type" : "list",
"member" : {
"shape" : "__string"
}
},
"__long" : {
"type" : "long"
},
"__string" : {
"type" : "string"
},
"__timestamp" : {
"type" : "timestamp"
"__timestampIso8601" : {
"type" : "timestamp",
"timestampFormat" : "iso8601"
},
"__timestampUnix" : {
"type" : "timestamp",
"timestampFormat" : "unixTimestamp"
}
},
"documentation" : "Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols."

469
botocore/data/pinpoint/2016-12-01/service-2.json
View file

@ -710,7 +710,7 @@
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Deletes endpoints associated with an user id."
"documentation" : "Deletes endpoints that are associated with a User ID."
},
"GetAdmChannel" : {
"name" : "GetAdmChannel",
@ -1795,7 +1795,7 @@
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Returns information about the endpoints associated with an user id."
"documentation" : "Returns information about the endpoints that are associated with a User ID."
},
"PhoneNumberValidate" : {
"name" : "PhoneNumberValidate",
@ -1867,6 +1867,41 @@
} ],
"documentation" : "Use to create or update the event stream for an app."
},
"PutEvents" : {
"name" : "PutEvents",
"http" : {
"method" : "POST",
"requestUri" : "/v1/apps/{application-id}/events",
"responseCode" : 202
},
"input" : {
"shape" : "PutEventsRequest"
},
"output" : {
"shape" : "PutEventsResponse",
"documentation" : "202 response"
},
"errors" : [ {
"shape" : "BadRequestException",
"documentation" : "400 response"
}, {
"shape" : "InternalServerErrorException",
"documentation" : "500 response"
}, {
"shape" : "ForbiddenException",
"documentation" : "403 response"
}, {
"shape" : "NotFoundException",
"documentation" : "404 response"
}, {
"shape" : "MethodNotAllowedException",
"documentation" : "405 response"
}, {
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to record events for endpoints. This method creates events and creates or updates the endpoints that those events are associated with."
},
"RemoveAttributes" : {
"name" : "RemoveAttributes",
"http" : {
@ -1935,7 +1970,7 @@
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use this resource to send a direct message, which is a one time message that you send to a limited audience without creating a campaign. \n\nYou can send the message to up to 100 recipients. You cannot use the message to engage a segment. When you send the message, Amazon Pinpoint delivers it immediately, and you cannot schedule the delivery. To engage a user segment, and to schedule the message delivery, create a campaign instead of sending a direct message.\n\nYou can send a direct message as a push notification to your mobile app or as an SMS message to SMS-enabled devices."
"documentation" : "Used to send a direct message."
},
"SendUsersMessages" : {
"name" : "SendUsersMessages",
@ -1970,7 +2005,7 @@
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use this resource to message a list of users. Amazon Pinpoint sends the message to all of the endpoints that are associated with each user.\n\nA user represents an individual who is assigned a unique user ID, and this ID is assigned to one or more endpoints. For example, if an individual uses your app on multiple devices, your app could assign that person's user ID to the endpoint for each device.\n\nWith the users-messages resource, you specify the message recipients as user IDs. For each user ID, Amazon Pinpoint delivers the message to all of the user's endpoints. Within the body of your request, you can specify a default message, and you can tailor your message for different channels, including those for mobile push and SMS.\n\nWith this resource, you send a direct message, which is a one time message that you send to a limited audience without creating a campaign. You can send the message to up to 100 users per request. You cannot use the message to engage a segment. When you send the message, Amazon Pinpoint delivers it immediately, and you cannot schedule the delivery. To engage a user segment, and to schedule the message delivery, create a campaign instead of using the users-messages resource."
"documentation" : "Used to send a message to a list of users."
},
"UpdateAdmChannel" : {
"name" : "UpdateAdmChannel",
@ -2425,7 +2460,7 @@
"shape" : "TooManyRequestsException",
"documentation" : "429 response"
} ],
"documentation" : "Use to update a segment."
"documentation" : "Used to update a segment."
},
"UpdateSmsChannel" : {
"name" : "UpdateSmsChannel",
@ -2469,15 +2504,15 @@
"members" : {
"ClientId" : {
"shape" : "__string",
"documentation" : "Client ID as gotten from Amazon"
"documentation" : "The Client ID that you obtained from the Amazon App Distribution Portal."
},
"ClientSecret" : {
"shape" : "__string",
"documentation" : "Client secret as gotten from Amazon"
"documentation" : "The Client Secret that you obtained from the Amazon App Distribution Portal."
},
"Enabled" : {
"shape" : "__boolean",
"documentation" : "If the channel is enabled for sending messages."
"documentation" : "Indicates whether or not the channel is enabled for sending messages."
}
},
"documentation" : "Amazon Device Messaging channel definition.",
@ -2492,11 +2527,11 @@
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "When was this segment created"
"documentation" : "The date and time when this channel was created."
},
"Enabled" : {
"shape" : "__boolean",
"documentation" : "If the channel is enabled for sending messages."
"documentation" : "Indicates whether or not the channel is enabled for sending messages."
},
"HasCredential" : {
"shape" : "__boolean",
@ -2504,27 +2539,27 @@
},
"Id" : {
"shape" : "__string",
"documentation" : "Channel ID. Not used, only for backwards compatibility."
"documentation" : "(Deprecated) An identifier for the channel. Retained for backwards compatibility."
},
"IsArchived" : {
"shape" : "__boolean",
"documentation" : "Is this channel archived"
"documentation" : "Indicates whether or not the channel is archived."
},
"LastModifiedBy" : {
"shape" : "__string",
"documentation" : "Who last updated this entry"
"documentation" : "The user who last updated this channel."
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "Last date this was updated"
"documentation" : "The date and time when this channel was last modified."
},
"Platform" : {
"shape" : "__string",
"documentation" : "Platform type. Will be \"ADM\""
"documentation" : "The platform type. For this channel, the value is always \"ADM.\""
},
"Version" : {
"shape" : "__integer",
"documentation" : "Version of channel"
"documentation" : "The channel version."
}
},
"documentation" : "Amazon Device Messaging channel definition.",
@ -2539,7 +2574,7 @@
},
"Body" : {
"shape" : "__string",
"documentation" : "The message body of the notification, the email body or the text message."
"documentation" : "The message body of the notification."
},
"ConsolidationKey" : {
"shape" : "__string",
@ -2644,11 +2679,11 @@
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The ID of the application to which the channel applies."
"documentation" : "The ID of the application that the channel applies to."
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "When was this segment created"
"documentation" : "The date and time when this channel was created."
},
"DefaultAuthenticationMethod" : {
"shape" : "__string",
@ -2668,27 +2703,27 @@
},
"Id" : {
"shape" : "__string",
"documentation" : "Channel ID. Not used. Present only for backwards compatibility."
"documentation" : "(Deprecated) An identifier for the channel. Retained for backwards compatibility."
},
"IsArchived" : {
"shape" : "__boolean",
"documentation" : "Is this channel archived"
"documentation" : "Indicates whether or not the channel is archived."
},
"LastModifiedBy" : {
"shape" : "__string",
"documentation" : "Who last updated this entry"
"documentation" : "The user who last updated this channel."
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "Last date this was updated"
"documentation" : "The date and time when this channel was last modified."
},
"Platform" : {
"shape" : "__string",
"documentation" : "The platform type. Will be APNS."
"documentation" : "The platform type. For this channel, the value is always \"ADM.\""
},
"Version" : {
"shape" : "__integer",
"documentation" : "Version of channel"
"documentation" : "The channel version."
}
},
"documentation" : "Apple Distribution Push Notification Service channel definition.",
@ -2707,7 +2742,7 @@
},
"Body" : {
"shape" : "__string",
"documentation" : "The message body of the notification, the email body or the text message."
"documentation" : "The message body of the notification."
},
"Category" : {
"shape" : "__string",
@ -3060,6 +3095,10 @@
"Item" : {
"shape" : "ListOfActivityResponse",
"documentation" : "List of campaign activities"
},
"NextToken" : {
"shape" : "__string",
"documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response."
}
},
"documentation" : "Activities for campaign.",
@ -3345,7 +3384,7 @@
},
"Body" : {
"shape" : "__string",
"documentation" : "The message body of the notification, the email body or the text message."
"documentation" : "The message body of the notification."
},
"Data" : {
"shape" : "MapOf__string",
@ -3799,7 +3838,7 @@
"documentation" : "Default message substitutions. Can be overridden by individual address substitutions."
}
},
"documentation" : "Default Message across push notification, email, and sms."
"documentation" : "The default message to use across all channels."
},
"DefaultPushNotificationMessage" : {
"type" : "structure",
@ -3810,7 +3849,7 @@
},
"Body" : {
"shape" : "__string",
"documentation" : "The message body of the notification, the email body or the text message."
"documentation" : "The message body of the notification."
},
"Data" : {
"shape" : "MapOf__string",
@ -4327,7 +4366,7 @@
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +1206XXX5550100. For the email channel, use an email address."
"documentation" : "The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
@ -4400,30 +4439,44 @@
},
"Make" : {
"shape" : "__string",
"documentation" : "The endpoint make, such as such as Apple or Samsung."
"documentation" : "The manufacturer of the endpoint device, such as Apple or Samsung."
},
"Model" : {
"shape" : "__string",
"documentation" : "The endpoint model, such as iPhone."
"documentation" : "The model name or number of the endpoint device, such as iPhone."
},
"ModelVersion" : {
"shape" : "__string",
"documentation" : "The endpoint model version."
"documentation" : "The model version of the endpoint device."
},
"Platform" : {
"shape" : "__string",
"documentation" : "The endpoint platform, such as ios or android."
"documentation" : "The platform of the endpoint device, such as iOS or Android."
},
"PlatformVersion" : {
"shape" : "__string",
"documentation" : "The endpoint platform version."
"documentation" : "The platform version of the endpoint device."
},
"Timezone" : {
"shape" : "__string",
"documentation" : "The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles."
}
},
"documentation" : "Endpoint demographic data"
"documentation" : "Demographic information about the endpoint."
},
"EndpointItemResponse" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "A custom message associated with the registration of an endpoint when issuing a response."
},
"StatusCode" : {
"shape" : "__integer",
"documentation" : "The status code to respond with for a particular endpoint id after endpoint registration"
}
},
"documentation" : "The responses that are returned after you create or update an endpoint and record an event."
},
"EndpointLocation" : {
"type" : "structure",
@ -4434,15 +4487,15 @@
},
"Country" : {
"shape" : "__string",
"documentation" : "Country according to ISO 3166-1 Alpha-2 codes. For example, US."
"documentation" : "The two-letter code for the country or region of the endpoint. Specified as an ISO 3166-1 Alpha-2 code, such as \"US\" for the United States."
},
"Latitude" : {
"shape" : "__double",
"documentation" : "The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile)."
"documentation" : "The latitude of the endpoint location, rounded to one decimal place."
},
"Longitude" : {
"shape" : "__double",
"documentation" : "The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile)."
"documentation" : "The longitude of the endpoint location, rounded to one decimal place."
},
"PostalCode" : {
"shape" : "__string",
@ -4450,10 +4503,10 @@
},
"Region" : {
"shape" : "__string",
"documentation" : "The region of the endpoint location. For example, corresponds to a state in US."
"documentation" : "The region of the endpoint location. For example, in the United States, this corresponds to a state."
}
},
"documentation" : "Endpoint location data"
"documentation" : "Location data for the endpoint."
},
"EndpointMessageResult" : {
"type" : "structure",
@ -4464,7 +4517,7 @@
},
"DeliveryStatus" : {
"shape" : "DeliveryStatus",
"documentation" : "Delivery status of message."
"documentation" : "The delivery status of the message. Possible values:\n\nSUCCESS - The message was successfully delivered to the endpoint.\n\nTRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.\n\nFAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.\n\nTIMEOUT - The message couldn't be sent within the timeout period.\n\nQUIET_TIME - The local time for the endpoint was within the Quiet Hours for the campaign.\n\nDAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period.\n\nHOLDOUT - The endpoint was in a hold out treatment for the campaign.\n\nTHROTTLED - Amazon Pinpoint throttled sending to this endpoint.\n\nEXPIRED - The endpoint address is expired.\n\nCAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign.\n\nSERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message.\n\nUNKNOWN - An unknown error occurred."
},
"MessageId" : {
"shape" : "__string",
@ -4491,7 +4544,7 @@
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +1206XXX5550100. For the email channel, use an email address."
"documentation" : "The destination for messages that you send to this endpoint. The address varies by channel. For mobile push channels, use the token provided by the push notification service, such as the APNs device token or the FCM registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
@ -4503,11 +4556,11 @@
},
"Demographic" : {
"shape" : "EndpointDemographic",
"documentation" : "The endpoint demographic attributes."
"documentation" : "Demographic attributes for the endpoint."
},
"EffectiveDate" : {
"shape" : "__string",
"documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format."
"documentation" : "The date and time when the endpoint was updated, shown in ISO 8601 format."
},
"EndpointStatus" : {
"shape" : "__string",
@ -4541,15 +4594,15 @@
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId)."
"documentation" : "The address of the endpoint as provided by your push provider. For example, the DeviceToken or RegistrationId."
},
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The ID of the application associated with the endpoint."
"documentation" : "The ID of the application that is associated with the endpoint."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
"documentation" : "Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named \"interests\" might have the values [\"science\", \"politics\", \"travel\"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign.\n\nThe following characters are not recommended in attribute names: # : ? \\ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values."
"documentation" : "Custom attributes that describe the endpoint by associating a name with an array of values. For example, an attribute named \"interests\" might have the following values: [\"science\", \"politics\", \"travel\"]. You can use these attributes as selection criteria when you create segments.\n\nThe Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes."
},
"ChannelType" : {
"shape" : "ChannelType",
@ -4557,11 +4610,11 @@
},
"CohortId" : {
"shape" : "__string",
"documentation" : "A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign."
"documentation" : "A number from 0-99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign."
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "The last time the endpoint was created. Provided in ISO 8601 format."
"documentation" : "The date and time when the endpoint was created, shown in ISO 8601 format."
},
"Demographic" : {
"shape" : "EndpointDemographic",
@ -4569,7 +4622,7 @@
},
"EffectiveDate" : {
"shape" : "__string",
"documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format."
"documentation" : "The date and time when the endpoint was last updated, shown in ISO 8601 format."
},
"EndpointStatus" : {
"shape" : "__string",
@ -4577,7 +4630,7 @@
},
"Id" : {
"shape" : "__string",
"documentation" : "The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application."
"documentation" : "The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint IDs associated with the application."
},
"Location" : {
"shape" : "EndpointLocation",
@ -4633,7 +4686,7 @@
"members" : {
"UserAttributes" : {
"shape" : "MapOfListOf__string",
"documentation" : "Custom attributes that describe an end user by associating a name with an array of values. For example, an attribute named \"interests\" might have the values [\"science\", \"politics\", \"travel\"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign.\n\nThe following characters are not recommended in attribute names: # : ? \\ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values."
"documentation" : "Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named \"interests\" might have the following values: [\"science\", \"politics\", \"travel\"]. You can use these attributes as selection criteria when you create segments.\n\nThe Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes."
},
"UserId" : {
"shape" : "__string",
@ -4653,6 +4706,51 @@
"documentation" : "List of endpoints",
"required" : [ ]
},
"Event" : {
"type" : "structure",
"members" : {
"Attributes" : {
"shape" : "MapOf__string",
"documentation" : "Custom attributes that are associated with the event you're adding or updating."
},
"ClientSdkVersion" : {
"shape" : "__string",
"documentation" : "The version of the SDK that's running on the client device."
},
"EventType" : {
"shape" : "__string",
"documentation" : "The name of the custom event that you're recording."
},
"Metrics" : {
"shape" : "MapOf__double",
"documentation" : "Event metrics"
},
"Session" : {
"shape" : "Session",
"documentation" : "The session"
},
"Timestamp" : {
"shape" : "__string",
"documentation" : "The date and time when the event occurred, in ISO 8601 format."
}
},
"documentation" : "Model for creating or updating events.",
"required" : [ ]
},
"EventItemResponse" : {
"type" : "structure",
"members" : {
"Message" : {
"shape" : "__string",
"documentation" : "A custom message that is associated with the processing of an event."
},
"StatusCode" : {
"shape" : "__integer",
"documentation" : "The status code to respond with for a particular event id"
}
},
"documentation" : "The responses that are returned after you record an event."
},
"EventStream" : {
"type" : "structure",
"members" : {
@ -4666,7 +4764,7 @@
},
"ExternalId" : {
"shape" : "__string",
"documentation" : "DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
"documentation" : "(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
},
"LastModifiedDate" : {
"shape" : "__string",
@ -4684,6 +4782,42 @@
"documentation" : "Model for an event publishing subscription export.",
"required" : [ ]
},
"EventsBatch" : {
"type" : "structure",
"members" : {
"Endpoint" : {
"shape" : "PublicEndpoint",
"documentation" : "Endpoint information"
},
"Events" : {
"shape" : "MapOfEvent",
"documentation" : "Events"
}
},
"documentation" : "Events batch definition",
"required" : [ ]
},
"EventsRequest" : {
"type" : "structure",
"members" : {
"BatchItem" : {
"shape" : "MapOfEventsBatch",
"documentation" : "Batch of events with endpoint id as the key and an object of EventsBatch as value. The EventsBatch object has the PublicEndpoint and a map of event Id's to events"
}
},
"documentation" : "Put Events request",
"required" : [ ]
},
"EventsResponse" : {
"type" : "structure",
"members" : {
"Results" : {
"shape" : "MapOfItemResponse",
"documentation" : "A map containing a multi part response for each endpoint, with the endpoint id as the key and item response as the value"
}
},
"documentation" : "The results from processing a put events request"
},
"ExportJobRequest" : {
"type" : "structure",
"members" : {
@ -4735,7 +4869,7 @@
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The unique ID of the application to which the job applies."
"documentation" : "The unique ID of the application associated with the export job."
},
"CompletedPieces" : {
"shape" : "__integer",
@ -4905,7 +5039,7 @@
},
"Body" : {
"shape" : "__string",
"documentation" : "The message body of the notification, the email body or the text message."
"documentation" : "The message body of the notification."
},
"CollapseKey" : {
"shape" : "__string",
@ -5894,7 +6028,7 @@
},
"ExternalId" : {
"shape" : "__string",
"documentation" : "DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
"documentation" : "(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
},
"Format" : {
"shape" : "Format",
@ -5910,7 +6044,7 @@
},
"S3Url" : {
"shape" : "__string",
"documentation" : "A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.\nThe URL should follow this format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint will import endpoints from this location and any subfolders it contains."
"documentation" : "The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint imports endpoints from this location and any subfolders it contains."
},
"SegmentId" : {
"shape" : "__string",
@ -5933,7 +6067,7 @@
},
"ExternalId" : {
"shape" : "__string",
"documentation" : "DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
"documentation" : "(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
},
"Format" : {
"shape" : "Format",
@ -5949,7 +6083,7 @@
},
"S3Url" : {
"shape" : "__string",
"documentation" : "A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.\nThe URL should follow this format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint will import endpoints from this location and any subfolders it contains."
"documentation" : "The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint imports endpoints from this location and any subfolders it contains."
},
"SegmentId" : {
"shape" : "__string",
@ -6059,6 +6193,20 @@
"httpStatusCode" : 500
}
},
"ItemResponse" : {
"type" : "structure",
"members" : {
"EndpointItemResponse" : {
"shape" : "EndpointItemResponse",
"documentation" : "Endpoint item response after endpoint registration"
},
"EventsItemResponse" : {
"shape" : "MapOfEventItemResponse",
"documentation" : "Events item response is a multipart response object per event Id, with eventId as the key and EventItemResponse object as the value"
}
},
"documentation" : "The endpoint and events combined response definition"
},
"JobStatus" : {
"type" : "string",
"enum" : [ "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED" ]
@ -6184,6 +6332,10 @@
"MessageConfiguration" : {
"shape" : "DirectMessageConfiguration",
"documentation" : "Message configuration."
},
"TraceId" : {
"shape" : "__string",
"documentation" : "A unique ID that you can use to trace a message. This ID is visible to recipients."
}
},
"documentation" : "Send message request.",
@ -6217,7 +6369,7 @@
"members" : {
"DeliveryStatus" : {
"shape" : "DeliveryStatus",
"documentation" : "Delivery status of message."
"documentation" : "The delivery status of the message. Possible values:\n\nSUCCESS - The message was successfully delivered to the endpoint.\n\nTRANSIENT_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.\n\nFAILURE_PERMANENT - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.\n\nTIMEOUT - The message couldn't be sent within the timeout period.\n\nQUIET_TIME - The local time for the endpoint was within the Quiet Hours for the campaign.\n\nDAILY_CAP - The endpoint has received the maximum number of messages it can receive within a 24-hour period.\n\nHOLDOUT - The endpoint was in a hold out treatment for the campaign.\n\nTHROTTLED - Amazon Pinpoint throttled sending to this endpoint.\n\nEXPIRED - The endpoint address is expired.\n\nCAMPAIGN_CAP - The endpoint received the maximum number of messages allowed by the campaign.\n\nSERVICE_FAILURE - A service-level failure prevented Amazon Pinpoint from delivering the message.\n\nUNKNOWN - An unknown error occurred."
},
"MessageId" : {
"shape" : "__string",
@ -6302,11 +6454,11 @@
"members" : {
"IsoCountryCode" : {
"shape" : "__string",
"documentation" : "(Optional) The two-character ISO country code for the country where the phone number was originally registered."
"documentation" : "(Optional) The two-character ISO country code for the country or region where the phone number was originally registered."
},
"PhoneNumber" : {
"shape" : "__string",
"documentation" : "The phone number to get information about."
"documentation" : "The phone number to get information about. The phone number that you provide should include a country code. If the number doesn't include a valid country code, the operation might result in an error."
}
},
"documentation" : "Phone Number Information request."
@ -6316,7 +6468,7 @@
"members" : {
"Carrier" : {
"shape" : "__string",
"documentation" : "The carrier that the phone number is registered with."
"documentation" : "The carrier or servive provider that the phone number is currently registered with."
},
"City" : {
"shape" : "__string",
@ -6324,23 +6476,23 @@
},
"CleansedPhoneNumberE164" : {
"shape" : "__string",
"documentation" : "The cleansed (standardized) phone number in E.164 format."
"documentation" : "The cleansed phone number, shown in E.164 format."
},
"CleansedPhoneNumberNational" : {
"shape" : "__string",
"documentation" : "The cleansed phone number in national format."
"documentation" : "The cleansed phone number, shown in the local phone number format."
},
"Country" : {
"shape" : "__string",
"documentation" : "The country where the phone number was originally registered."
"documentation" : "The country or region where the phone number was originally registered."
},
"CountryCodeIso2" : {
"shape" : "__string",
"documentation" : "The two-character ISO country code for the country where the phone number was originally registered."
"documentation" : "The two-character ISO code for the country or region where the phone number was originally registered."
},
"CountryCodeNumeric" : {
"shape" : "__string",
"documentation" : "The numeric country code for the country where the phone number was originally registered."
"documentation" : "The numeric code for the country or region where the phone number was originally registered."
},
"County" : {
"shape" : "__string",
@ -6348,7 +6500,7 @@
},
"OriginalCountryCodeIso2" : {
"shape" : "__string",
"documentation" : "The two-character ISO country code that was included in the request body."
"documentation" : "The two-character ISO code for the country or region that you included in the request body."
},
"OriginalPhoneNumber" : {
"shape" : "__string",
@ -6356,11 +6508,11 @@
},
"PhoneType" : {
"shape" : "__string",
"documentation" : "A description of the phone type. Possible values include MOBILE, LANDLINE, VOIP, INVALID, and OTHER."
"documentation" : "A description of the phone type. Possible values are MOBILE, LANDLINE, VOIP, INVALID, PREPAID, and OTHER."
},
"PhoneTypeCode" : {
"shape" : "__integer",
"documentation" : "The phone type as an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), and 4 (OTHER)."
"documentation" : "The phone type, represented by an integer. Possible values include 0 (MOBILE), 1 (LANDLINE), 2 (VOIP), 3 (INVALID), 4 (OTHER), and 5 (PREPAID)."
},
"Timezone" : {
"shape" : "__string",
@ -6368,7 +6520,7 @@
},
"ZipCode" : {
"shape" : "__string",
"documentation" : "The zip code for the location where the phone number was originally registered."
"documentation" : "The postal code for the location where the phone number was originally registered."
}
},
"documentation" : "Phone Number Information response."
@ -6393,6 +6545,56 @@
"required" : [ "NumberValidateResponse" ],
"payload" : "NumberValidateResponse"
},
"PublicEndpoint" : {
"type" : "structure",
"members" : {
"Address" : {
"shape" : "__string",
"documentation" : "The unique identifier for the recipient. For example, an address could be a device token or an endpoint ID."
},
"Attributes" : {
"shape" : "MapOfListOf__string",
"documentation" : "Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment."
},
"ChannelType" : {
"shape" : "ChannelType",
"documentation" : "The channel type.\n\nValid values: APNS, GCM"
},
"Demographic" : {
"shape" : "EndpointDemographic",
"documentation" : "The endpoint demographic attributes."
},
"EffectiveDate" : {
"shape" : "__string",
"documentation" : "The date and time when the endpoint was last updated."
},
"EndpointStatus" : {
"shape" : "__string",
"documentation" : "The status of the endpoint. If the update fails, the value is INACTIVE. If the endpoint is updated successfully, the value is ACTIVE."
},
"Location" : {
"shape" : "EndpointLocation",
"documentation" : "The endpoint location attributes."
},
"Metrics" : {
"shape" : "MapOf__double",
"documentation" : "Custom metrics that your app reports to Amazon Pinpoint."
},
"OptOut" : {
"shape" : "__string",
"documentation" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL - User has opted out of all messages.\n\nNONE - Users has not opted out and receives all messages."
},
"RequestId" : {
"shape" : "__string",
"documentation" : "A unique identifier that is generated each time the endpoint is updated."
},
"User" : {
"shape" : "EndpointUser",
"documentation" : "Custom user-specific attributes that your app reports to Amazon Pinpoint."
}
},
"documentation" : "Public endpoint attributes."
},
"PutEventStreamRequest" : {
"type" : "structure",
"members" : {
@ -6419,6 +6621,32 @@
"required" : [ "EventStream" ],
"payload" : "EventStream"
},
"PutEventsRequest" : {
"type" : "structure",
"members" : {
"ApplicationId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "application-id",
"documentation" : "The unique ID of your Amazon Pinpoint application."
},
"EventsRequest" : {
"shape" : "EventsRequest"
}
},
"required" : [ "ApplicationId", "EventsRequest" ],
"payload" : "EventsRequest"
},
"PutEventsResponse" : {
"type" : "structure",
"members" : {
"EventsResponse" : {
"shape" : "EventsResponse"
}
},
"required" : [ "EventsResponse" ],
"payload" : "EventsResponse"
},
"QuietTime" : {
"type" : "structure",
"members" : {
@ -6706,15 +6934,15 @@
},
"SourceSegments" : {
"shape" : "ListOfSegmentReference",
"documentation" : "Segments that define the source of this segment. Currently a maximum of 1 import segment is supported."
"documentation" : "The base segment that you build your segment on. The source segment defines the starting \"universe\" of endpoints. When you add dimensions to the segment, it filters the source segment based on the dimensions that you specify. You can specify more than one dimensional segment. You can only specify one imported segment."
},
"SourceType" : {
"shape" : "SourceType",
"documentation" : "Include or exclude the source."
"documentation" : "Specify how to handle multiple source segments. For example, if you specify three source segments, should the resulting segment be based on any or all of the segments? Acceptable values: ANY or ALL."
},
"Type" : {
"shape" : "Type",
"documentation" : "How should the dimensions be applied for the result"
"documentation" : "Specify how to handle multiple segment dimensions. For example, if you specify three dimensions, should the resulting segment include endpoints that are matched by all, any, or none of the dimensions? Acceptable values: ALL, ANY, or NONE."
}
},
"documentation" : "Segment group definition.",
@ -6725,11 +6953,11 @@
"members" : {
"Groups" : {
"shape" : "ListOfSegmentGroup",
"documentation" : "List of dimension groups to evaluate."
"documentation" : "A set of segment criteria to evaluate."
},
"Include" : {
"shape" : "Include",
"documentation" : "How should the groups be applied for the result"
"documentation" : "Specify how to handle multiple segment groups. For example, if the segment includes three segment groups, should the resulting segment include endpoints that are matched by all, any, or none of the segment groups you created. Acceptable values: ALL, ANY, or NONE."
}
},
"documentation" : "Segment group definition.",
@ -6740,11 +6968,11 @@
"members" : {
"ChannelCounts" : {
"shape" : "MapOf__integer",
"documentation" : "Channel type counts"
"documentation" : "The number of channel types in the imported segment."
},
"ExternalId" : {
"shape" : "__string",
"documentation" : "DEPRECATED. Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
"documentation" : "(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint."
},
"Format" : {
"shape" : "Format",
@ -6756,7 +6984,7 @@
},
"S3Url" : {
"shape" : "__string",
"documentation" : "A URL that points to the Amazon S3 location from which the endpoints for this segment were imported."
"documentation" : "The URL of the S3 bucket that the segment was imported from."
},
"Size" : {
"shape" : "__integer",
@ -6785,7 +7013,7 @@
"members" : {
"Id" : {
"shape" : "__string",
"documentation" : "Segment Id."
"documentation" : "A unique identifier for the segment."
},
"Version" : {
"shape" : "__integer",
@ -6799,11 +7027,11 @@
"members" : {
"ApplicationId" : {
"shape" : "__string",
"documentation" : "The ID of the application to which the segment applies."
"documentation" : "The ID of the application that the segment applies to."
},
"CreationDate" : {
"shape" : "__string",
"documentation" : "The date the segment was created in ISO 8601 format."
"documentation" : "The date and time when the segment was created."
},
"Dimensions" : {
"shape" : "SegmentDimensions",
@ -6819,15 +7047,15 @@
},
"LastModifiedDate" : {
"shape" : "__string",
"documentation" : "The date the segment was last updated in ISO 8601 format."
"documentation" : "The date and time when the segment was last modified."
},
"Name" : {
"shape" : "__string",
"documentation" : "The name of segment"
"documentation" : "The name of the segment."
},
"SegmentGroups" : {
"shape" : "SegmentGroupList",
"documentation" : "Segment definition groups. We currently only support one. If specified Dimensions must be empty."
"documentation" : "A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments."
},
"SegmentType" : {
"shape" : "SegmentType",
@ -6897,6 +7125,10 @@
"shape" : "DirectMessageConfiguration",
"documentation" : "Message definitions for the default message and any messages that are tailored for specific channels."
},
"TraceId" : {
"shape" : "__string",
"documentation" : "A unique ID that you can use to trace a message. This ID is visible to recipients."
},
"Users" : {
"shape" : "MapOfEndpointSendConfiguration",
"documentation" : "A map that associates user IDs with EndpointSendConfiguration objects. Within an EndpointSendConfiguration object, you can tailor the message for a user by specifying message overrides or substitutions."
@ -6950,6 +7182,29 @@
"required" : [ "SendUsersMessageResponse" ],
"payload" : "SendUsersMessageResponse"
},
"Session" : {
"type" : "structure",
"members" : {
"Duration" : {
"shape" : "__integer",
"documentation" : "Session duration in millis"
},
"Id" : {
"shape" : "__string",
"documentation" : "A unique identifier for the session."
},
"StartTimestamp" : {
"shape" : "__string",
"documentation" : "The date and time when the session began."
},
"StopTimestamp" : {
"shape" : "__string",
"documentation" : "The date and time when the session ended."
}
},
"documentation" : "Information about a session.",
"required" : [ ]
},
"SetDimension" : {
"type" : "structure",
"members" : {
@ -6967,7 +7222,7 @@
},
"SourceType" : {
"type" : "string",
"enum" : [ "ALL", "ANY" ]
"enum" : [ "ALL", "ANY", "NONE" ]
},
"TooManyRequestsException" : {
"type" : "structure",
@ -7526,7 +7781,7 @@
},
"SegmentGroups" : {
"shape" : "SegmentGroupList",
"documentation" : "Segment definition groups. We currently only support one. If specified Dimensions must be empty."
"documentation" : "A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments. Your request can only include one segment group. Your request can include either a SegmentGroups object or a Dimensions object, but not both."
}
},
"documentation" : "Segment definition.",
@ -7700,6 +7955,42 @@
"shape" : "EndpointSendConfiguration"
}
},
"MapOfEvent" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "Event"
}
},
"MapOfEventItemResponse" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "EventItemResponse"
}
},
"MapOfEventsBatch" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "EventsBatch"
}
},
"MapOfItemResponse" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "ItemResponse"
}
},
"MapOfMessageResult" : {
"type" : "map",
"key" : {

357
botocore/data/polly/2016-06-10/service-2.json
View file

@ -55,6 +55,22 @@
],
"documentation":"<p>Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see <a href=\"http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html\">Managing Lexicons</a>.</p>"
},
"GetSpeechSynthesisTask":{
"name":"GetSpeechSynthesisTask",
"http":{
"method":"GET",
"requestUri":"/v1/synthesisTasks/{TaskId}",
"responseCode":200
},
"input":{"shape":"GetSpeechSynthesisTaskInput"},
"output":{"shape":"GetSpeechSynthesisTaskOutput"},
"errors":[
{"shape":"InvalidTaskIdException"},
{"shape":"ServiceFailureException"},
{"shape":"SynthesisTaskNotFoundException"}
],
"documentation":"<p>Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.</p>"
},
"ListLexicons":{
"name":"ListLexicons",
"http":{
@ -70,6 +86,21 @@
],
"documentation":"<p>Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see <a href=\"http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html\">Managing Lexicons</a>.</p>"
},
"ListSpeechSynthesisTasks":{
"name":"ListSpeechSynthesisTasks",
"http":{
"method":"GET",
"requestUri":"/v1/synthesisTasks",
"responseCode":200
},
"input":{"shape":"ListSpeechSynthesisTasksInput"},
"output":{"shape":"ListSpeechSynthesisTasksOutput"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.</p>"
},
"PutLexicon":{
"name":"PutLexicon",
"http":{
@ -90,6 +121,30 @@
],
"documentation":"<p>Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html\">Managing Lexicons</a>.</p>"
},
"StartSpeechSynthesisTask":{
"name":"StartSpeechSynthesisTask",
"http":{
"method":"POST",
"requestUri":"/v1/synthesisTasks",
"responseCode":200
},
"input":{"shape":"StartSpeechSynthesisTaskInput"},
"output":{"shape":"StartSpeechSynthesisTaskOutput"},
"errors":[
{"shape":"TextLengthExceededException"},
{"shape":"InvalidS3BucketException"},
{"shape":"InvalidS3KeyException"},
{"shape":"InvalidSampleRateException"},
{"shape":"InvalidSnsTopicArnException"},
{"shape":"InvalidSsmlException"},
{"shape":"LexiconNotFoundException"},
{"shape":"ServiceFailureException"},
{"shape":"MarksNotSupportedForFormatException"},
{"shape":"SsmlMarksNotSupportedForTextTypeException"},
{"shape":"LanguageNotSupportedException"}
],
"documentation":"<p>Allows the creation of an asynchronous synthesis task, by starting a new <code>SpeechSynthesisTask</code>. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status.</p>"
},
"SynthesizeSpeech":{
"name":"SynthesizeSpeech",
"http":{
@ -106,7 +161,8 @@
{"shape":"LexiconNotFoundException"},
{"shape":"ServiceFailureException"},
{"shape":"MarksNotSupportedForFormatException"},
{"shape":"SsmlMarksNotSupportedForTextTypeException"}
{"shape":"SsmlMarksNotSupportedForTextTypeException"},
{"shape":"LanguageNotSupportedException"}
],
"documentation":"<p>Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see <a href=\"http://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html\">How it Works</a>.</p>"
}
@ -118,6 +174,7 @@
"streaming":true
},
"ContentType":{"type":"string"},
"DateTime":{"type":"timestamp"},
"DeleteLexiconInput":{
"type":"structure",
"required":["Name"],
@ -144,6 +201,12 @@
"location":"querystring",
"locationName":"LanguageCode"
},
"IncludeAdditionalLanguageCodes":{
"shape":"IncludeAdditionalLanguageCodes",
"documentation":"<p>Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify <code>yes</code> but not if you specify <code>no</code>.</p>",
"location":"querystring",
"locationName":"IncludeAdditionalLanguageCodes"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>An opaque pagination token returned from the previous <code>DescribeVoices</code> operation. If present, this indicates where to continue the listing.</p>",
@ -198,6 +261,28 @@
}
}
},
"GetSpeechSynthesisTaskInput":{
"type":"structure",
"required":["TaskId"],
"members":{
"TaskId":{
"shape":"TaskId",
"documentation":"<p>The Amazon Polly generated identifier for a speech synthesis task.</p>",
"location":"uri",
"locationName":"TaskId"
}
}
},
"GetSpeechSynthesisTaskOutput":{
"type":"structure",
"members":{
"SynthesisTask":{
"shape":"SynthesisTask",
"documentation":"<p>SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.</p>"
}
}
},
"IncludeAdditionalLanguageCodes":{"type":"boolean"},
"InvalidLexiconException":{
"type":"structure",
"members":{
@ -216,6 +301,24 @@
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidS3BucketException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidS3KeyException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidSampleRateException":{
"type":"structure",
"members":{
@ -225,6 +328,15 @@
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidSnsTopicArnException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidSsmlException":{
"type":"structure",
"members":{
@ -234,6 +346,15 @@
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidTaskIdException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The provided Task ID is not valid. Please provide a valid Task ID and try again.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LanguageCode":{
"type":"string",
"enum":[
@ -251,8 +372,9 @@
"fr-FR",
"is-IS",
"it-IT",
"ko-KR",
"ja-JP",
"hi-IN",
"ko-KR",
"nb-NO",
"nl-NL",
"pl-PL",
@ -264,7 +386,20 @@
"tr-TR"
]
},
"LanguageCodeList":{
"type":"list",
"member":{"shape":"LanguageCode"}
},
"LanguageName":{"type":"string"},
"LanguageNotSupportedException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The language specified is not currently supported by Amazon Polly in this capacity.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"LastModified":{"type":"timestamp"},
"LexemesCount":{"type":"integer"},
"Lexicon":{
@ -383,6 +518,42 @@
}
}
},
"ListSpeechSynthesisTasksInput":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Maximum number of speech synthesis tasks returned in a List operation.</p>",
"location":"querystring",
"locationName":"MaxResults"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The pagination token to use in the next request to continue the listing of speech synthesis tasks. </p>",
"location":"querystring",
"locationName":"NextToken"
},
"Status":{
"shape":"TaskStatus",
"documentation":"<p>Status of the speech synthesis tasks returned in a List operation</p>",
"location":"querystring",
"locationName":"Status"
}
}
},
"ListSpeechSynthesisTasksOutput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.</p>"
},
"SynthesisTasks":{
"shape":"SynthesisTasks",
"documentation":"<p>List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.</p>"
}
}
},
"MarksNotSupportedForFormatException":{
"type":"structure",
"members":{
@ -410,6 +581,11 @@
"error":{"httpStatusCode":400},
"exception":true
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"NextToken":{"type":"string"},
"OutputFormat":{
"type":"string",
@ -420,6 +596,15 @@
"pcm"
]
},
"OutputS3BucketName":{
"type":"string",
"pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$"
},
"OutputS3KeyPrefix":{
"type":"string",
"pattern":"^[0-9a-zA-Z\\/\\!\\-_\\.\\*\\'\\(\\)]{0,800}$"
},
"OutputUri":{"type":"string"},
"PutLexiconInput":{
"type":"structure",
"required":[
@ -457,6 +642,10 @@
"fault":true
},
"Size":{"type":"integer"},
"SnsTopicArn":{
"type":"string",
"pattern":"^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:.*:\\w{12}:.+$"
},
"SpeechMarkType":{
"type":"string",
"enum":[
@ -480,6 +669,145 @@
"error":{"httpStatusCode":400},
"exception":true
},
"StartSpeechSynthesisTaskInput":{
"type":"structure",
"required":[
"OutputFormat",
"OutputS3BucketName",
"Text",
"VoiceId"
],
"members":{
"LexiconNames":{
"shape":"LexiconNameList",
"documentation":"<p>List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. </p>"
},
"OutputFormat":{
"shape":"OutputFormat",
"documentation":"<p>The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. </p>"
},
"OutputS3BucketName":{
"shape":"OutputS3BucketName",
"documentation":"<p>Amazon S3 bucket name to which the output file will be saved.</p>"
},
"OutputS3KeyPrefix":{
"shape":"OutputS3KeyPrefix",
"documentation":"<p>The Amazon S3 key prefix for the output speech file.</p>"
},
"SampleRate":{
"shape":"SampleRate",
"documentation":"<p>The audio frequency specified in Hz.</p> <p>The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", and \"22050\". The default value is \"22050\".</p> <p>Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\". </p>"
},
"SnsTopicArn":{
"shape":"SnsTopicArn",
"documentation":"<p>ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.</p>"
},
"SpeechMarkTypes":{
"shape":"SpeechMarkTypeList",
"documentation":"<p>The type of speech marks returned for the input text.</p>"
},
"Text":{
"shape":"Text",
"documentation":"<p>The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text. </p>"
},
"TextType":{
"shape":"TextType",
"documentation":"<p>Specifies whether the input text is plain text or SSML. The default value is plain text. </p>"
},
"VoiceId":{
"shape":"VoiceId",
"documentation":"<p>Voice ID to use for the synthesis. </p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). </p> <p>If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html\">DescribeVoices</a> operation for the <code>LanguageCode</code> parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.</p>"
}
}
},
"StartSpeechSynthesisTaskOutput":{
"type":"structure",
"members":{
"SynthesisTask":{
"shape":"SynthesisTask",
"documentation":"<p>SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.</p>"
}
}
},
"SynthesisTask":{
"type":"structure",
"members":{
"TaskId":{
"shape":"TaskId",
"documentation":"<p>The Amazon Polly generated identifier for a speech synthesis task.</p>"
},
"TaskStatus":{
"shape":"TaskStatus",
"documentation":"<p>Current status of the individual speech synthesis task.</p>"
},
"TaskStatusReason":{
"shape":"TaskStatusReason",
"documentation":"<p>Reason for the current status of a specific speech synthesis task, including errors if the task has failed.</p>"
},
"OutputUri":{
"shape":"OutputUri",
"documentation":"<p>Pathway for the output speech file.</p>"
},
"CreationTime":{
"shape":"DateTime",
"documentation":"<p>Timestamp for the time the synthesis task was started.</p>"
},
"RequestCharacters":{
"shape":"RequestCharacters",
"documentation":"<p>Number of billable characters synthesized.</p>"
},
"SnsTopicArn":{
"shape":"SnsTopicArn",
"documentation":"<p>ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.</p>"
},
"LexiconNames":{
"shape":"LexiconNameList",
"documentation":"<p>List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. </p>"
},
"OutputFormat":{
"shape":"OutputFormat",
"documentation":"<p>The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json. </p>"
},
"SampleRate":{
"shape":"SampleRate",
"documentation":"<p>The audio frequency specified in Hz.</p> <p>The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", and \"22050\". The default value is \"22050\".</p> <p>Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\". </p>"
},
"SpeechMarkTypes":{
"shape":"SpeechMarkTypeList",
"documentation":"<p>The type of speech marks returned for the input text.</p>"
},
"TextType":{
"shape":"TextType",
"documentation":"<p>Specifies whether the input text is plain text or SSML. The default value is plain text. </p>"
},
"VoiceId":{
"shape":"VoiceId",
"documentation":"<p>Voice ID to use for the synthesis. </p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). </p> <p>If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html\">DescribeVoices</a> operation for the <code>LanguageCode</code> parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.</p>"
}
},
"documentation":"<p>SynthesisTask object that provides information about a speech synthesis task.</p>"
},
"SynthesisTaskNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The Speech Synthesis task with requested Task ID cannot be found.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"SynthesisTasks":{
"type":"list",
"member":{"shape":"SynthesisTask"}
},
"SynthesizeSpeechInput":{
"type":"structure",
"required":[
@ -515,6 +843,10 @@
"VoiceId":{
"shape":"VoiceId",
"documentation":"<p> Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the <a href=\"http://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html\">DescribeVoices</a> operation. </p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN). </p> <p>If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the <a href=\"https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html\">DescribeVoices</a> operation for the <code>LanguageCode</code> parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.</p>"
}
}
},
@ -540,13 +872,28 @@
},
"payload":"AudioStream"
},
"TaskId":{
"type":"string",
"max":128,
"min":1
},
"TaskStatus":{
"type":"string",
"enum":[
"scheduled",
"inProgress",
"completed",
"failed"
]
},
"TaskStatusReason":{"type":"string"},
"Text":{"type":"string"},
"TextLengthExceededException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The value of the \"Text\" parameter is longer than the accepted limits. The limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. SSML tags are not counted as billed characters.</p>",
"documentation":"<p>The value of the \"Text\" parameter is longer than the accepted limits. For the <code>SynthesizeSpeech</code> API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the <code>StartSpeechSynthesisTask</code> API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
@ -597,6 +944,10 @@
"Name":{
"shape":"VoiceName",
"documentation":"<p>Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.</p>"
},
"AdditionalLanguageCodes":{
"shape":"LanguageCodeList",
"documentation":"<p>Additional codes for languages available for the specified voice in addition to its default language. </p> <p>For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code <code>hi-IN</code>.</p>"
}
},
"documentation":"<p>Description of the voice.</p>"

232
botocore/data/rds/2014-10-31/service-2.json
View file

@ -301,7 +301,8 @@
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"AuthorizationNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DomainNotFoundFault"}
{"shape":"DomainNotFoundFault"},
{"shape":"BackupPolicyNotFoundFault"}
],
"documentation":"<p>Creates a new DB instance.</p>"
},
@ -1116,6 +1117,24 @@
],
"documentation":"<p>Lists all tags on an Amazon RDS resource.</p> <p>For an overview on tagging an Amazon RDS resource, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html\">Tagging Amazon RDS Resources</a>.</p>"
},
"ModifyCurrentDBClusterCapacity":{
"name":"ModifyCurrentDBClusterCapacity",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyCurrentDBClusterCapacityMessage"},
"output":{
"shape":"DBClusterCapacityInfo",
"resultWrapper":"ModifyCurrentDBClusterCapacityResult"
},
"errors":[
{"shape":"DBClusterNotFoundFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"InvalidDBClusterCapacityFault"}
],
"documentation":"<p>Set the capacity of an Aurora Serverless DB cluster to a specific value.</p> <p>Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call <code>ModifyCurrentDBClusterCapacity</code> to set the capacity explicitly.</p> <p>After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.</p> <p>For more information about Aurora Serverless, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless</a> in the <i>Amazon RDS User Guide</i>.</p> <important> <p>If you call <code>ModifyCurrentDBClusterCapacity</code> with the default <code>TimeoutAction</code>, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling\"> Autoscaling for Aurora Serverless</a> in the <i>Amazon RDS User Guide</i>.</p> </important>"
},
"ModifyDBCluster":{
"name":"ModifyDBCluster",
"http":{
@ -1204,7 +1223,8 @@
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"AuthorizationNotFoundFault"},
{"shape":"CertificateNotFoundFault"},
{"shape":"DomainNotFoundFault"}
{"shape":"DomainNotFoundFault"},
{"shape":"BackupPolicyNotFoundFault"}
],
"documentation":"<p>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call <a>DescribeValidDBInstanceModifications</a> before you call <a>ModifyDBInstance</a>. </p>"
},
@ -1588,7 +1608,8 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DBSecurityGroupNotFoundFault"},
{"shape":"DomainNotFoundFault"},
{"shape":"DBParameterGroupNotFoundFault"}
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"BackupPolicyNotFoundFault"}
],
"documentation":"<p>Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.</p> <p>If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.</p> <p>If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code> must be the ARN of the shared DB snapshot.</p> <note> <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <a>RestoreDBClusterFromSnapshot</a>.</p> </note>"
},
@ -1619,7 +1640,8 @@
{"shape":"OptionGroupNotFoundFault"},
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"AuthorizationNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"}
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"BackupPolicyNotFoundFault"}
],
"documentation":"<p>Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html\">Importing Data into an Amazon RDS MySQL DB Instance</a>. </p>"
},
@ -1654,7 +1676,8 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DBSecurityGroupNotFoundFault"},
{"shape":"DomainNotFoundFault"},
{"shape":"DBParameterGroupNotFoundFault"}
{"shape":"DBParameterGroupNotFoundFault"},
{"shape":"BackupPolicyNotFoundFault"}
],
"documentation":"<p>Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.</p> <p>The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.</p> <note> <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <a>RestoreDBClusterToPointInTime</a>.</p> </note>"
},
@ -2007,6 +2030,17 @@
},
"documentation":"<p/>"
},
"BackupPolicyNotFoundFault":{
"type":"structure",
"members":{
},
"error":{
"code":"BackupPolicyNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"Boolean":{"type":"boolean"},
"BooleanOptional":{"type":"boolean"},
"Certificate":{
@ -2099,7 +2133,7 @@
"documentation":"<p>The list of log types to disable.</p>"
}
},
"documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.</p>"
"documentation":"<p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.</p> <p>The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"CopyDBClusterParameterGroupMessage":{
"type":"structure",
@ -2366,7 +2400,15 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p>"
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"EngineMode":{
"shape":"String",
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code> or <code>serverless</code>.</p>"
},
"ScalingConfiguration":{
"shape":"ScalingConfiguration",
"documentation":"<p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>"
}
},
"documentation":"<p/>"
@ -2537,7 +2579,7 @@
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</p> <p>Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.</p> <ul> <li> <p> <b>Default VPC:</b> true</p> </li> <li> <p> <b>VPC:</b> false</p> </li> </ul> <p>If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.</p>"
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</p> <p>Default: The default behavior varies depending on whether <code>DBSubnetGroupName</code> is specified.</p> <p>If <code>DBSubnetGroupName</code> is not specified, and <code>PubliclyAccessible</code> is not specified, the following applies:</p> <ul> <li> <p>If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.</p> </li> <li> <p>If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.</p> </li> </ul> <p>If <code>DBSubnetGroupName</code> is specified, and <code>PubliclyAccessible</code> is not specified, the following applies:</p> <ul> <li> <p>If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.</p> </li> <li> <p>If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.</p> </li> </ul>"
},
"Tags":{"shape":"TagList"},
"DBClusterIdentifier":{
@ -2610,7 +2652,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs.</p>"
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"ProcessorFeatures":{
"shape":"ProcessorFeatureList",
@ -2664,7 +2706,7 @@
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</p> <p>Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.</p> <ul> <li> <p> <b>Default VPC:</b>true</p> </li> <li> <p> <b>VPC:</b>false</p> </li> </ul> <p>If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.</p>"
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see <a>CreateDBInstance</a>.</p>"
},
"Tags":{"shape":"TagList"},
"DBSubnetGroupName":{
@ -2713,7 +2755,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of logs that the new DB instance is to export to CloudWatch Logs.</p>"
"documentation":"<p>The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"ProcessorFeatures":{
"shape":"ProcessorFeatureList",
@ -3080,8 +3122,14 @@
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB cluster is configured to export to CloudWatch Logs.</p>"
}
"documentation":"<p>A list of log types that this DB cluster is configured to export to CloudWatch Logs.</p> <p>Log types vary by DB engine. For information about the log types for each DB engine, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html\">Amazon RDS Database Log Files</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"Capacity":{"shape":"IntegerOptional"},
"EngineMode":{
"shape":"String",
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code> or <code>serverless</code>.</p>"
},
"ScalingConfigurationInfo":{"shape":"ScalingConfigurationInfo"}
},
"documentation":"<p>Contains the details of an Amazon RDS DB cluster. </p> <p>This data type is used as a response element in the <a>DescribeDBClusters</a> action. </p>",
"wrapper":true
@ -3161,6 +3209,31 @@
},
"exception":true
},
"DBClusterCapacityInfo":{
"type":"structure",
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. </p>"
},
"PendingCapacity":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the capacity that the DB cluster scales to next.</p>"
},
"CurrentCapacity":{
"shape":"IntegerOptional",
"documentation":"<p>The current capacity of the DB cluster.</p>"
},
"SecondsBeforeTimeout":{
"shape":"IntegerOptional",
"documentation":"<p>The number of seconds before a call to <code>ModifyCurrentDBClusterCapacity</code> times out.</p>"
},
"TimeoutAction":{
"shape":"String",
"documentation":"<p>The timeout action of a call to <code>ModifyCurrentDBClusterCapacity</code>, either <code>ForceApplyCapacityChange</code> or <code>RollbackCapacityChange</code>.</p>"
}
}
},
"DBClusterList":{
"type":"list",
"member":{
@ -3347,7 +3420,8 @@
"Status":{
"shape":"String",
"documentation":"<p>Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:</p> <ul> <li> <p> <code>ACTIVE</code> - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.</p> </li> <li> <p> <code>PENDING</code> - the IAM role ARN is being associated with the DB cluster.</p> </li> <li> <p> <code>INVALID</code> - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.</p> </li> </ul>"
}
},
"FeatureName":{"shape":"String"}
},
"documentation":"<p>Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.</p>"
},
@ -3612,6 +3686,10 @@
"SupportsReadReplica":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the database engine version supports read replicas.</p>"
},
"SupportedEngineModes":{
"shape":"EngineModeList",
"documentation":"<p>A list of the supported DB engine modes.</p>"
}
},
"documentation":"<p> This data type is used as a response element in the action <a>DescribeDBEngineVersions</a>. </p>"
@ -3762,7 +3840,7 @@
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</p> <p>Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.</p> <ul> <li> <p> <b>Default VPC:</b>true</p> </li> <li> <p> <b>VPC:</b>false</p> </li> </ul> <p>If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.</p>"
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</p>"
},
"StatusInfos":{
"shape":"DBInstanceStatusInfoList",
@ -3850,7 +3928,7 @@
},
"EnabledCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p>"
"documentation":"<p>A list of log types that this DB instance is configured to export to CloudWatch Logs.</p> <p>Log types vary by DB engine. For information about the log types for each DB engine, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html\">Amazon RDS Database Log Files</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"ProcessorFeatures":{
"shape":"ProcessorFeatureList",
@ -3918,7 +3996,7 @@
},
"Status":{
"shape":"String",
"documentation":"<p>Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.</p>"
"documentation":"<p>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.</p>"
},
"Message":{
"shape":"String",
@ -5713,6 +5791,10 @@
"documentation":"<p> Contains the result of a successful invocation of the <a>DescribeEngineDefaultParameters</a> action. </p>",
"wrapper":true
},
"EngineModeList":{
"type":"list",
"member":{"shape":"String"}
},
"Event":{
"type":"structure",
"members":{
@ -6006,6 +6088,18 @@
},
"Integer":{"type":"integer"},
"IntegerOptional":{"type":"integer"},
"InvalidDBClusterCapacityFault":{
"type":"structure",
"members":{
},
"documentation":"<p> <i>Capacity</i> isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>128</code>, and <code>256</code>.</p>",
"error":{
"code":"InvalidDBClusterCapacityFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBClusterSnapshotStateFault":{
"type":"structure",
"members":{
@ -6223,6 +6317,28 @@
},
"Long":{"type":"long"},
"LongOptional":{"type":"long"},
"ModifyCurrentDBClusterCapacityMessage":{
"type":"structure",
"required":["DBClusterIdentifier"],
"members":{
"DBClusterIdentifier":{
"shape":"String",
"documentation":"<p>The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing DB cluster.</p> </li> </ul>"
},
"Capacity":{
"shape":"IntegerOptional",
"documentation":"<p>The DB cluster capacity.</p> <p>Constraints:</p> <ul> <li> <p>Value must be <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>128</code>, or <code>256</code>.</p> </li> </ul>"
},
"SecondsBeforeTimeout":{
"shape":"IntegerOptional",
"documentation":"<p>The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.</p> <ul> <li> <p>Value must be from 10 through 600.</p> </li> </ul>"
},
"TimeoutAction":{
"shape":"String",
"documentation":"<p>The action to take when the timeout is reached, either <code>ForceApplyCapacityChange</code> or <code>RollbackCapacityChange</code>.</p> <p> <code>ForceApplyCapacityChange</code>, the default, sets the capacity to the specified value as soon as possible.</p> <p> <code>RollbackCapacityChange</code> ignores the capacity change if a scaling point is not found in the timeout period.</p>"
}
}
},
"ModifyDBClusterMessage":{
"type":"structure",
"required":["DBClusterIdentifier"],
@ -6286,6 +6402,10 @@
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.</p> <p>For a list of valid engine versions, see <a>CreateDBCluster</a>, or call <a>DescribeDBEngineVersions</a>.</p>"
},
"ScalingConfiguration":{
"shape":"ScalingConfiguration",
"documentation":"<p>The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in <code>serverless</code> DB engine mode.</p>"
}
},
"documentation":"<p/>"
@ -7190,6 +7310,10 @@
"AvailableProcessorFeatures":{
"shape":"AvailableProcessorFeatureList",
"documentation":"<p>A list of the available processor features for the DB instance class of a DB instance.</p>"
},
"SupportedEngineModes":{
"shape":"EngineModeList",
"documentation":"<p>A list of the supported DB engine modes.</p>"
}
},
"documentation":"<p>Contains a list of available options for a DB instance.</p> <p> This data type is used as a response element in the <a>DescribeOrderableDBInstanceOptions</a> action. </p>",
@ -7258,6 +7382,10 @@
"ApplyMethod":{
"shape":"ApplyMethod",
"documentation":"<p>Indicates when to apply parameter updates.</p>"
},
"SupportedEngineModes":{
"shape":"EngineModeList",
"documentation":"<p>The valid DB engine modes.</p>"
}
},
"documentation":"<p> This data type is used as a request parameter in the <a>ModifyDBParameterGroup</a> and <a>ResetDBParameterGroup</a> actions. </p> <p>This data type is used as a response element in the <a>DescribeEngineDefaultParameters</a> and <a>DescribeDBParameters</a> actions.</p>"
@ -8050,7 +8178,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs.</p>"
"documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
}
}
},
@ -8126,7 +8254,15 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs.</p>"
"documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"EngineMode":{
"shape":"String",
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code> or <code>serverless</code>.</p>"
},
"ScalingConfiguration":{
"shape":"ScalingConfiguration",
"documentation":"<p>For DB clusters in <code>serverless</code> DB engine mode, the scaling properties of the DB cluster.</p>"
}
},
"documentation":"<p/>"
@ -8195,7 +8331,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs.</p>"
"documentation":"<p>The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
}
},
"documentation":"<p/>"
@ -8243,7 +8379,7 @@
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</p> <p>Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.</p> <ul> <li> <p> <b>Default VPC:</b> true</p> </li> <li> <p> <b>VPC:</b> false</p> </li> </ul> <p>If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.</p>"
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see <a>CreateDBInstance</a>.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
@ -8300,7 +8436,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of logs that the restored DB instance is to export to CloudWatch Logs.</p>"
"documentation":"<p>The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"ProcessorFeatures":{
"shape":"ProcessorFeatureList",
@ -8421,7 +8557,7 @@
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies whether the DB instance is publicly accessible or not. For more information, see <a>CreateDBInstance</a>. </p>"
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see <a>CreateDBInstance</a>.</p>"
},
"Tags":{
"shape":"TagList",
@ -8489,7 +8625,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of logs that the restored DB instance is to export to CloudWatch Logs.</p>"
"documentation":"<p>The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"ProcessorFeatures":{
"shape":"ProcessorFeatureList",
@ -8552,7 +8688,7 @@
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.</p> <p>Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.</p> <ul> <li> <p> <b>Default VPC:</b>true</p> </li> <li> <p> <b>VPC:</b>false</p> </li> </ul> <p>If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.</p>"
"documentation":"<p>Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see <a>CreateDBInstance</a>.</p>"
},
"AutoMinorVersionUpgrade":{
"shape":"BooleanOptional",
@ -8609,7 +8745,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of logs that the restored DB instance is to export to CloudWatch Logs.</p>"
"documentation":"<p>The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs </a> in the <i>Amazon Relational Database Service User Guide</i>.</p>"
},
"ProcessorFeatures":{
"shape":"ProcessorFeatureList",
@ -8697,6 +8833,50 @@
},
"exception":true
},
"ScalingConfiguration":{
"type":"structure",
"members":{
"MinCapacity":{
"shape":"IntegerOptional",
"documentation":"<p>The minimum capacity for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p> <p>Valid capacity values are <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>128</code>, and <code>256</code>.</p> <p>The minimum capacity must be less than or equal to the maximum capacity.</p>"
},
"MaxCapacity":{
"shape":"IntegerOptional",
"documentation":"<p>The maximum capacity for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p> <p>Valid capacity values are <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>, <code>32</code>, <code>64</code>, <code>128</code>, and <code>256</code>.</p> <p>The maximum capacity must be greater than or equal to the minimum capacity.</p>"
},
"AutoPause":{
"shape":"BooleanOptional",
"documentation":"<p>A value that specifies whether to allow or disallow automatic pause for an Aurora DB cluster in <code>serverless</code> DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).</p> <note> <p>If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. </p> </note>"
},
"SecondsUntilAutoPause":{
"shape":"IntegerOptional",
"documentation":"<p>The time, in seconds, before an Aurora DB cluster in <code>serverless</code> mode is paused.</p>"
}
},
"documentation":"<p>Contains the scaling configuration of an Aurora Serverless DB cluster.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"ScalingConfigurationInfo":{
"type":"structure",
"members":{
"MinCapacity":{
"shape":"IntegerOptional",
"documentation":"<p>The maximum capacity for the Aurora DB cluster in <code>serverless</code> DB engine mode.</p>"
},
"MaxCapacity":{
"shape":"IntegerOptional",
"documentation":"<p>The maximum capacity for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p>"
},
"AutoPause":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether automatic pause is allowed for the Aurora DB cluster in <code>serverless</code> DB engine mode. </p>"
},
"SecondsUntilAutoPause":{
"shape":"IntegerOptional",
"documentation":"<p>The remaining amount of time, in seconds, before the Aurora DB cluster in <code>serverless</code> mode is paused. A DB cluster can be paused only when it's idle (it has no connections).</p>"
}
},
"documentation":"<p>Shows the scaling configuration for an Aurora DB cluster in <code>serverless</code> DB engine mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html\">Using Amazon Aurora Serverless</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"SharedSnapshotQuotaExceededFault":{
"type":"structure",
"members":{

146
botocore/data/redshift/2012-12-01/service-2.json
View file

@ -122,7 +122,8 @@
{"shape":"TagLimitExceededFault"},
{"shape":"InvalidTagFault"},
{"shape":"LimitExceededFault"},
{"shape":"DependentServiceRequestThrottlingFault"}
{"shape":"DependentServiceRequestThrottlingFault"},
{"shape":"InvalidClusterTrackFault"}
],
"documentation":"<p>Creates a new cluster.</p> <p>To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
@ -549,6 +550,23 @@
],
"documentation":"<p>Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.</p> <p>If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have <code>owner</code> and <code>environment</code> for tag keys, and <code>admin</code> and <code>test</code> for tag values, all subnet groups that have any combination of those values are returned.</p> <p>If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.</p>"
},
"DescribeClusterTracks":{
"name":"DescribeClusterTracks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeClusterTracksMessage"},
"output":{
"shape":"TrackListMessage",
"resultWrapper":"DescribeClusterTracksResult"
},
"errors":[
{"shape":"InvalidClusterTrackFault"},
{"shape":"UnauthorizedOperation"}
],
"documentation":"<p>Returns a list of all the available maintenance tracks.</p>"
},
"DescribeClusterVersions":{
"name":"DescribeClusterVersions",
"http":{
@ -917,7 +935,7 @@
{"shape":"UnsupportedOperationFault"},
{"shape":"DependentServiceUnavailableFault"}
],
"documentation":"<p>Returns an array of ReservedNodeOfferings which is filtered by payment type, term, and instance type.</p>"
"documentation":"<p>Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.</p>"
},
"ModifyCluster":{
"name":"ModifyCluster",
@ -947,7 +965,8 @@
{"shape":"LimitExceededFault"},
{"shape":"DependentServiceRequestThrottlingFault"},
{"shape":"InvalidElasticIpFault"},
{"shape":"TableLimitExceededFault"}
{"shape":"TableLimitExceededFault"},
{"shape":"InvalidClusterTrackFault"}
],
"documentation":"<p>Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html\">Amazon Redshift Clusters</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p> <p>You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.</p>"
},
@ -1152,7 +1171,8 @@
{"shape":"ClusterParameterGroupNotFoundFault"},
{"shape":"ClusterSecurityGroupNotFoundFault"},
{"shape":"LimitExceededFault"},
{"shape":"DependentServiceRequestThrottlingFault"}
{"shape":"DependentServiceRequestThrottlingFault"},
{"shape":"InvalidClusterTrackFault"}
],
"documentation":"<p>Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the <a>ModifyCluster</a> API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.</p> <p>If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.</p> <p> For more information about working with snapshots, go to <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html\">Amazon Redshift Snapshots</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"
},
@ -1243,11 +1263,11 @@
"members":{
"ReservedNodeId":{
"shape":"String",
"documentation":"<p>A string representing the identifier of the Reserved Node to be exchanged.</p>"
"documentation":"<p>A string representing the node identifier of the DC1 Reserved Node to be exchanged.</p>"
},
"TargetReservedNodeOfferingId":{
"shape":"String",
"documentation":"<p>The unique identifier of the Reserved Node offering to be used for the exchange.</p>"
"documentation":"<p>The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling <a>GetReservedNodeExchangeOfferings</a> </p>"
}
}
},
@ -1554,6 +1574,10 @@
"PendingActions":{
"shape":"PendingActionsList",
"documentation":"<p>Cluster operations that are waiting to be started.</p>"
},
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name of the maintenance track for the cluster.</p>"
}
},
"documentation":"<p>Describes a cluster.</p>",
@ -2340,6 +2364,10 @@
"IamRoles":{
"shape":"IamRoleArnList",
"documentation":"<p>A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.</p> <p>A cluster can have up to 10 IAM roles associated with it at any time.</p>"
},
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the <code>current</code> track.</p>"
}
},
"documentation":"<p/>"
@ -2991,6 +3019,23 @@
},
"documentation":"<p/>"
},
"DescribeClusterTracksMessage":{
"type":"structure",
"members":{
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name of the maintenance track. </p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p>An integer value for the maximum number of maintenance tracks to return.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeClusterTracks</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Redshift returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>"
}
}
},
"DescribeClusterVersionsMessage":{
"type":"structure",
"members":{
@ -3417,6 +3462,13 @@
},
"documentation":"<p>Describes the status of the elastic IP (EIP) address.</p>"
},
"EligibleTracksToUpdateList":{
"type":"list",
"member":{
"shape":"UpdateTarget",
"locationName":"UpdateTarget"
}
},
"EnableLoggingMessage":{
"type":"structure",
"required":[
@ -3733,7 +3785,7 @@
"members":{
"ReservedNodeId":{
"shape":"String",
"documentation":"<p>A string representing the node identifier for the Reserved Node to be exchanged.</p>"
"documentation":"<p>A string representing the node identifier for the DC1 Reserved Node to be exchanged.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
@ -4103,6 +4155,18 @@
},
"exception":true
},
"InvalidClusterTrackFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The provided cluster track name is not valid.</p>",
"error":{
"code":"InvalidClusterTrack",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidElasticIpFault":{
"type":"structure",
"members":{
@ -4303,6 +4367,24 @@
},
"Long":{"type":"long"},
"LongOptional":{"type":"long"},
"MaintenanceTrack":{
"type":"structure",
"members":{
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name of the maintenance track. Possible values are <code>current</code> and <code>trailing</code>.</p>"
},
"DatabaseVersion":{
"shape":"String",
"documentation":"<p>The version number for the cluster release.</p>"
},
"UpdateTargets":{
"shape":"EligibleTracksToUpdateList",
"documentation":"<p>An array of <a>UpdateTarget</a> objects to update with the maintenance track. </p>"
}
},
"documentation":"<p>Defines a maintenance track that determines which Amazon Redshift version to apply during a maintenance window. If the value for <code>MaintenanceTrack</code> is <code>current</code>, the cluster is updated to the most recently certified maintenance release. If the value is <code>trailing</code>, the cluster is updated to the previously certified maintenance release. </p>"
},
"ModifyClusterDbRevisionMessage":{
"type":"structure",
"required":[
@ -4426,6 +4508,10 @@
"EnhancedVpcRouting":{
"shape":"BooleanOptional",
"documentation":"<p>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html\">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>"
},
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the <code>PendingModifiedValues</code> for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.</p>"
}
},
"documentation":"<p/>"
@ -4720,6 +4806,10 @@
"EnhancedVpcRouting":{
"shape":"BooleanOptional",
"documentation":"<p>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html\">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>"
},
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name of the maintenance track that the cluster will change to during the next maintenance window.</p>"
}
},
"documentation":"<p>Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.</p>"
@ -5187,6 +5277,10 @@
"IamRoles":{
"shape":"IamRoleArnList",
"documentation":"<p>A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.</p> <p>A cluster can have up to 10 IAM roles associated at any time.</p>"
},
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the <code>MaintenanceTrack</code> value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.</p>"
}
},
"documentation":"<p/>"
@ -5535,6 +5629,10 @@
"EnhancedVpcRouting":{
"shape":"Boolean",
"documentation":"<p>An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see <a href=\"http://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html\">Enhanced VPC Routing</a> in the Amazon Redshift Cluster Management Guide.</p> <p>If this option is <code>true</code>, enhanced VPC routing is enabled. </p> <p>Default: false</p>"
},
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name of the maintenance track for the snapshot.</p>"
}
},
"documentation":"<p>Describes a snapshot.</p>",
@ -6023,6 +6121,26 @@
},
"documentation":"<p/>"
},
"TrackList":{
"type":"list",
"member":{
"shape":"MaintenanceTrack",
"locationName":"MaintenanceTrack"
}
},
"TrackListMessage":{
"type":"structure",
"members":{
"MaintenanceTracks":{
"shape":"TrackList",
"documentation":"<p>A list of maintenance tracks output by the <code>DescribeClusterTracks</code> operation. </p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>"
}
}
},
"UnauthorizedOperation":{
"type":"structure",
"members":{
@ -6071,6 +6189,20 @@
},
"exception":true
},
"UpdateTarget":{
"type":"structure",
"members":{
"MaintenanceTrackName":{
"shape":"String",
"documentation":"<p>The name of the new maintenance track.</p>"
},
"DatabaseVersion":{
"shape":"String",
"documentation":"<p>The cluster version for the new maintenance track.</p>"
}
},
"documentation":"<p>A maintenance track that you can switch the current track to.</p>"
},
"VpcSecurityGroupIdList":{
"type":"list",
"member":{

60
botocore/data/resource-groups/2017-11-27/service-2.json
View file

@ -104,8 +104,8 @@
"ListGroupResources":{
"name":"ListGroupResources",
"http":{
"method":"GET",
"requestUri":"/groups/{GroupName}/resource-identifiers"
"method":"POST",
"requestUri":"/groups/{GroupName}/resource-identifiers-list"
},
"input":{"shape":"ListGroupResourcesInput"},
"output":{"shape":"ListGroupResourcesOutput"},
@ -123,8 +123,8 @@
"ListGroups":{
"name":"ListGroups",
"http":{
"method":"GET",
"requestUri":"/groups"
"method":"POST",
"requestUri":"/groups-list"
},
"input":{"shape":"ListGroupsInput"},
"output":{"shape":"ListGroupsOutput"},
@ -247,7 +247,7 @@
"members":{
"Name":{
"shape":"GroupName",
"documentation":"<p>The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with <code>AWS</code> or <code>aws</code>; these are reserved. A resource group name must be unique within your account.</p>"
"documentation":"<p>The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with <code>AWS</code> or <code>aws</code>; these are reserved. A resource group name must be unique within your account.</p>"
},
"Description":{
"shape":"GroupDescription",
@ -259,7 +259,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 127 characters, and tag values can have a maximum length of 255 characters.</p>"
"documentation":"<p>The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
}
}
},
@ -411,7 +411,7 @@
"GroupDescription":{
"type":"string",
"max":512,
"pattern":"[\\sa-zA-Z0-9_\\.-]+"
"pattern":"[\\sa-zA-Z0-9_\\.-]*"
},
"GroupList":{
"type":"list",
@ -460,6 +460,10 @@
"location":"uri",
"locationName":"GroupName"
},
"Filters":{
"shape":"ResourceFilterList",
"documentation":"<p>Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation.</p> <ul> <li> <p> <code>resource-type</code> - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.</p> </li> </ul>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of group member ARNs that are returned in a single call by ListGroupResources, in paginated output. By default, this number is 50.</p>",
@ -551,7 +555,45 @@
},
"ResourceArn":{
"type":"string",
"pattern":"arn:aws:[a-z0-9]*:([a-z]{2}-[a-z]+-\\d{1})?:([0-9]{12})?:.+"
"pattern":"arn:aws:[a-z0-9\\-]*:([a-z]{2}-[a-z]+-\\d{1})?:([0-9]{12})?:.+"
},
"ResourceFilter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"ResourceFilterName",
"documentation":"<p>The name of the filter. Filter names are case-sensitive.</p>"
},
"Values":{
"shape":"ResourceFilterValues",
"documentation":"<p>One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.</p>"
}
},
"documentation":"<p>A filter name and value pair that is used to obtain more specific results from a list of resources.</p>"
},
"ResourceFilterList":{
"type":"list",
"member":{"shape":"ResourceFilter"}
},
"ResourceFilterName":{
"type":"string",
"enum":["resource-type"]
},
"ResourceFilterValue":{
"type":"string",
"max":128,
"min":1,
"pattern":"AWS::[a-zA-Z0-9]+::[a-zA-Z0-9]+"
},
"ResourceFilterValues":{
"type":"list",
"member":{"shape":"ResourceFilterValue"},
"max":5,
"min":1
},
"ResourceIdentifier":{
"type":"structure",
@ -639,7 +681,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 127 characters, and tag values can have a maximum length of 255 characters.</p>"
"documentation":"<p>The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
}
}
},

1419
botocore/data/s3/2006-03-01/service-2.json
View file

@ -26,7 +26,7 @@
{"shape":"NoSuchUpload"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html",
"documentation":"<p>Aborts a multipart upload.</p><p>To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.</p>"
"documentation":"<p>Aborts a multipart upload.</p> <p>To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.</p>"
},
"CompleteMultipartUpload":{
"name":"CompleteMultipartUpload",
@ -37,7 +37,7 @@
"input":{"shape":"CompleteMultipartUploadRequest"},
"output":{"shape":"CompleteMultipartUploadOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html",
"documentation":"Completes a multipart upload by assembling previously uploaded parts."
"documentation":"<p>Completes a multipart upload by assembling previously uploaded parts.</p>"
},
"CopyObject":{
"name":"CopyObject",
@ -51,7 +51,7 @@
{"shape":"ObjectNotInActiveTierError"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html",
"documentation":"Creates a copy of an object that is already stored in Amazon S3.",
"documentation":"<p>Creates a copy of an object that is already stored in Amazon S3.</p>",
"alias":"PutObjectCopy"
},
"CreateBucket":{
@ -67,7 +67,7 @@
{"shape":"BucketAlreadyOwnedByYou"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html",
"documentation":"Creates a new bucket.",
"documentation":"<p>Creates a new bucket.</p>",
"alias":"PutBucket"
},
"CreateMultipartUpload":{
@ -79,7 +79,7 @@
"input":{"shape":"CreateMultipartUploadRequest"},
"output":{"shape":"CreateMultipartUploadOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html",
"documentation":"<p>Initiates a multipart upload and returns an upload ID.</p><p><b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p>",
"documentation":"<p>Initiates a multipart upload and returns an upload ID.</p> <p> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p>",
"alias":"InitiateMultipartUpload"
},
"DeleteBucket":{
@ -90,7 +90,7 @@
},
"input":{"shape":"DeleteBucketRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html",
"documentation":"Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted."
"documentation":"<p>Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.</p>"
},
"DeleteBucketAnalyticsConfiguration":{
"name":"DeleteBucketAnalyticsConfiguration",
@ -99,7 +99,7 @@
"requestUri":"/{Bucket}?analytics"
},
"input":{"shape":"DeleteBucketAnalyticsConfigurationRequest"},
"documentation":"Deletes an analytics configuration for the bucket (specified by the analytics configuration ID)."
"documentation":"<p>Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).</p>"
},
"DeleteBucketCors":{
"name":"DeleteBucketCors",
@ -109,7 +109,7 @@
},
"input":{"shape":"DeleteBucketCorsRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html",
"documentation":"Deletes the cors configuration information set for the bucket."
"documentation":"<p>Deletes the cors configuration information set for the bucket.</p>"
},
"DeleteBucketEncryption":{
"name":"DeleteBucketEncryption",
@ -118,7 +118,7 @@
"requestUri":"/{Bucket}?encryption"
},
"input":{"shape":"DeleteBucketEncryptionRequest"},
"documentation":"Deletes the server-side encryption configuration from the bucket."
"documentation":"<p>Deletes the server-side encryption configuration from the bucket.</p>"
},
"DeleteBucketInventoryConfiguration":{
"name":"DeleteBucketInventoryConfiguration",
@ -127,7 +127,7 @@
"requestUri":"/{Bucket}?inventory"
},
"input":{"shape":"DeleteBucketInventoryConfigurationRequest"},
"documentation":"Deletes an inventory configuration (identified by the inventory ID) from the bucket."
"documentation":"<p>Deletes an inventory configuration (identified by the inventory ID) from the bucket.</p>"
},
"DeleteBucketLifecycle":{
"name":"DeleteBucketLifecycle",
@ -137,7 +137,7 @@
},
"input":{"shape":"DeleteBucketLifecycleRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html",
"documentation":"Deletes the lifecycle configuration from the bucket."
"documentation":"<p>Deletes the lifecycle configuration from the bucket.</p>"
},
"DeleteBucketMetricsConfiguration":{
"name":"DeleteBucketMetricsConfiguration",
@ -146,7 +146,7 @@
"requestUri":"/{Bucket}?metrics"
},
"input":{"shape":"DeleteBucketMetricsConfigurationRequest"},
"documentation":"Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket."
"documentation":"<p>Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.</p>"
},
"DeleteBucketPolicy":{
"name":"DeleteBucketPolicy",
@ -156,7 +156,7 @@
},
"input":{"shape":"DeleteBucketPolicyRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html",
"documentation":"Deletes the policy from the bucket."
"documentation":"<p>Deletes the policy from the bucket.</p>"
},
"DeleteBucketReplication":{
"name":"DeleteBucketReplication",
@ -165,7 +165,7 @@
"requestUri":"/{Bucket}?replication"
},
"input":{"shape":"DeleteBucketReplicationRequest"},
"documentation":"Deletes the replication configuration from the bucket."
"documentation":"<p>Deletes the replication configuration from the bucket.</p>"
},
"DeleteBucketTagging":{
"name":"DeleteBucketTagging",
@ -175,7 +175,7 @@
},
"input":{"shape":"DeleteBucketTaggingRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html",
"documentation":"Deletes the tags from the bucket."
"documentation":"<p>Deletes the tags from the bucket.</p>"
},
"DeleteBucketWebsite":{
"name":"DeleteBucketWebsite",
@ -185,7 +185,7 @@
},
"input":{"shape":"DeleteBucketWebsiteRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html",
"documentation":"This operation removes the website configuration from the bucket."
"documentation":"<p>This operation removes the website configuration from the bucket.</p>"
},
"DeleteObject":{
"name":"DeleteObject",
@ -196,7 +196,7 @@
"input":{"shape":"DeleteObjectRequest"},
"output":{"shape":"DeleteObjectOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html",
"documentation":"Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects."
"documentation":"<p>Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.</p>"
},
"DeleteObjectTagging":{
"name":"DeleteObjectTagging",
@ -206,7 +206,7 @@
},
"input":{"shape":"DeleteObjectTaggingRequest"},
"output":{"shape":"DeleteObjectTaggingOutput"},
"documentation":"Removes the tag-set from an existing object."
"documentation":"<p>Removes the tag-set from an existing object.</p>"
},
"DeleteObjects":{
"name":"DeleteObjects",
@ -217,7 +217,7 @@
"input":{"shape":"DeleteObjectsRequest"},
"output":{"shape":"DeleteObjectsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html",
"documentation":"This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.",
"documentation":"<p>This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.</p>",
"alias":"DeleteMultipleObjects"
},
"GetBucketAccelerateConfiguration":{
@ -228,7 +228,7 @@
},
"input":{"shape":"GetBucketAccelerateConfigurationRequest"},
"output":{"shape":"GetBucketAccelerateConfigurationOutput"},
"documentation":"Returns the accelerate configuration of a bucket."
"documentation":"<p>Returns the accelerate configuration of a bucket.</p>"
},
"GetBucketAcl":{
"name":"GetBucketAcl",
@ -239,7 +239,7 @@
"input":{"shape":"GetBucketAclRequest"},
"output":{"shape":"GetBucketAclOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html",
"documentation":"Gets the access control policy for the bucket."
"documentation":"<p>Gets the access control policy for the bucket.</p>"
},
"GetBucketAnalyticsConfiguration":{
"name":"GetBucketAnalyticsConfiguration",
@ -249,7 +249,7 @@
},
"input":{"shape":"GetBucketAnalyticsConfigurationRequest"},
"output":{"shape":"GetBucketAnalyticsConfigurationOutput"},
"documentation":"Gets an analytics configuration for the bucket (specified by the analytics configuration ID)."
"documentation":"<p>Gets an analytics configuration for the bucket (specified by the analytics configuration ID).</p>"
},
"GetBucketCors":{
"name":"GetBucketCors",
@ -260,7 +260,7 @@
"input":{"shape":"GetBucketCorsRequest"},
"output":{"shape":"GetBucketCorsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html",
"documentation":"Returns the cors configuration for the bucket."
"documentation":"<p>Returns the cors configuration for the bucket.</p>"
},
"GetBucketEncryption":{
"name":"GetBucketEncryption",
@ -270,7 +270,7 @@
},
"input":{"shape":"GetBucketEncryptionRequest"},
"output":{"shape":"GetBucketEncryptionOutput"},
"documentation":"Returns the server-side encryption configuration of a bucket."
"documentation":"<p>Returns the server-side encryption configuration of a bucket.</p>"
},
"GetBucketInventoryConfiguration":{
"name":"GetBucketInventoryConfiguration",
@ -280,7 +280,7 @@
},
"input":{"shape":"GetBucketInventoryConfigurationRequest"},
"output":{"shape":"GetBucketInventoryConfigurationOutput"},
"documentation":"Returns an inventory configuration (identified by the inventory ID) from the bucket."
"documentation":"<p>Returns an inventory configuration (identified by the inventory ID) from the bucket.</p>"
},
"GetBucketLifecycle":{
"name":"GetBucketLifecycle",
@ -291,7 +291,7 @@
"input":{"shape":"GetBucketLifecycleRequest"},
"output":{"shape":"GetBucketLifecycleOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html",
"documentation":"Deprecated, see the GetBucketLifecycleConfiguration operation.",
"documentation":"<p>Deprecated, see the GetBucketLifecycleConfiguration operation.</p>",
"deprecated":true
},
"GetBucketLifecycleConfiguration":{
@ -302,7 +302,7 @@
},
"input":{"shape":"GetBucketLifecycleConfigurationRequest"},
"output":{"shape":"GetBucketLifecycleConfigurationOutput"},
"documentation":"Returns the lifecycle configuration information set on the bucket."
"documentation":"<p>Returns the lifecycle configuration information set on the bucket.</p>"
},
"GetBucketLocation":{
"name":"GetBucketLocation",
@ -313,7 +313,7 @@
"input":{"shape":"GetBucketLocationRequest"},
"output":{"shape":"GetBucketLocationOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html",
"documentation":"Returns the region the bucket resides in."
"documentation":"<p>Returns the region the bucket resides in.</p>"
},
"GetBucketLogging":{
"name":"GetBucketLogging",
@ -324,7 +324,7 @@
"input":{"shape":"GetBucketLoggingRequest"},
"output":{"shape":"GetBucketLoggingOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html",
"documentation":"Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner."
"documentation":"<p>Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.</p>"
},
"GetBucketMetricsConfiguration":{
"name":"GetBucketMetricsConfiguration",
@ -334,7 +334,7 @@
},
"input":{"shape":"GetBucketMetricsConfigurationRequest"},
"output":{"shape":"GetBucketMetricsConfigurationOutput"},
"documentation":"Gets a metrics configuration (specified by the metrics configuration ID) from the bucket."
"documentation":"<p>Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.</p>"
},
"GetBucketNotification":{
"name":"GetBucketNotification",
@ -345,7 +345,7 @@
"input":{"shape":"GetBucketNotificationConfigurationRequest"},
"output":{"shape":"NotificationConfigurationDeprecated"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html",
"documentation":"Deprecated, see the GetBucketNotificationConfiguration operation.",
"documentation":"<p>Deprecated, see the GetBucketNotificationConfiguration operation.</p>",
"deprecated":true
},
"GetBucketNotificationConfiguration":{
@ -356,7 +356,7 @@
},
"input":{"shape":"GetBucketNotificationConfigurationRequest"},
"output":{"shape":"NotificationConfiguration"},
"documentation":"Returns the notification configuration of a bucket."
"documentation":"<p>Returns the notification configuration of a bucket.</p>"
},
"GetBucketPolicy":{
"name":"GetBucketPolicy",
@ -367,7 +367,7 @@
"input":{"shape":"GetBucketPolicyRequest"},
"output":{"shape":"GetBucketPolicyOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html",
"documentation":"Returns the policy of a specified bucket."
"documentation":"<p>Returns the policy of a specified bucket.</p>"
},
"GetBucketReplication":{
"name":"GetBucketReplication",
@ -377,7 +377,7 @@
},
"input":{"shape":"GetBucketReplicationRequest"},
"output":{"shape":"GetBucketReplicationOutput"},
"documentation":"Returns the replication configuration of a bucket."
"documentation":"<p>Returns the replication configuration of a bucket.</p>"
},
"GetBucketRequestPayment":{
"name":"GetBucketRequestPayment",
@ -388,7 +388,7 @@
"input":{"shape":"GetBucketRequestPaymentRequest"},
"output":{"shape":"GetBucketRequestPaymentOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html",
"documentation":"Returns the request payment configuration of a bucket."
"documentation":"<p>Returns the request payment configuration of a bucket.</p>"
},
"GetBucketTagging":{
"name":"GetBucketTagging",
@ -399,7 +399,7 @@
"input":{"shape":"GetBucketTaggingRequest"},
"output":{"shape":"GetBucketTaggingOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html",
"documentation":"Returns the tag set associated with the bucket."
"documentation":"<p>Returns the tag set associated with the bucket.</p>"
},
"GetBucketVersioning":{
"name":"GetBucketVersioning",
@ -410,7 +410,7 @@
"input":{"shape":"GetBucketVersioningRequest"},
"output":{"shape":"GetBucketVersioningOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html",
"documentation":"Returns the versioning state of a bucket."
"documentation":"<p>Returns the versioning state of a bucket.</p>"
},
"GetBucketWebsite":{
"name":"GetBucketWebsite",
@ -421,7 +421,7 @@
"input":{"shape":"GetBucketWebsiteRequest"},
"output":{"shape":"GetBucketWebsiteOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html",
"documentation":"Returns the website configuration for a bucket."
"documentation":"<p>Returns the website configuration for a bucket.</p>"
},
"GetObject":{
"name":"GetObject",
@ -435,7 +435,7 @@
{"shape":"NoSuchKey"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html",
"documentation":"Retrieves objects from Amazon S3."
"documentation":"<p>Retrieves objects from Amazon S3.</p>"
},
"GetObjectAcl":{
"name":"GetObjectAcl",
@ -449,7 +449,7 @@
{"shape":"NoSuchKey"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html",
"documentation":"Returns the access control list (ACL) of an object."
"documentation":"<p>Returns the access control list (ACL) of an object.</p>"
},
"GetObjectTagging":{
"name":"GetObjectTagging",
@ -459,7 +459,7 @@
},
"input":{"shape":"GetObjectTaggingRequest"},
"output":{"shape":"GetObjectTaggingOutput"},
"documentation":"Returns the tag-set of an object."
"documentation":"<p>Returns the tag-set of an object.</p>"
},
"GetObjectTorrent":{
"name":"GetObjectTorrent",
@ -470,7 +470,7 @@
"input":{"shape":"GetObjectTorrentRequest"},
"output":{"shape":"GetObjectTorrentOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html",
"documentation":"Return torrent files from a bucket."
"documentation":"<p>Return torrent files from a bucket.</p>"
},
"HeadBucket":{
"name":"HeadBucket",
@ -483,7 +483,7 @@
{"shape":"NoSuchBucket"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html",
"documentation":"This operation is useful to determine if a bucket exists and you have permission to access it."
"documentation":"<p>This operation is useful to determine if a bucket exists and you have permission to access it.</p>"
},
"HeadObject":{
"name":"HeadObject",
@ -497,7 +497,7 @@
{"shape":"NoSuchKey"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html",
"documentation":"The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object."
"documentation":"<p>The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.</p>"
},
"ListBucketAnalyticsConfigurations":{
"name":"ListBucketAnalyticsConfigurations",
@ -507,7 +507,7 @@
},
"input":{"shape":"ListBucketAnalyticsConfigurationsRequest"},
"output":{"shape":"ListBucketAnalyticsConfigurationsOutput"},
"documentation":"Lists the analytics configurations for the bucket."
"documentation":"<p>Lists the analytics configurations for the bucket.</p>"
},
"ListBucketInventoryConfigurations":{
"name":"ListBucketInventoryConfigurations",
@ -517,7 +517,7 @@
},
"input":{"shape":"ListBucketInventoryConfigurationsRequest"},
"output":{"shape":"ListBucketInventoryConfigurationsOutput"},
"documentation":"Returns a list of inventory configurations for the bucket."
"documentation":"<p>Returns a list of inventory configurations for the bucket.</p>"
},
"ListBucketMetricsConfigurations":{
"name":"ListBucketMetricsConfigurations",
@ -527,7 +527,7 @@
},
"input":{"shape":"ListBucketMetricsConfigurationsRequest"},
"output":{"shape":"ListBucketMetricsConfigurationsOutput"},
"documentation":"Lists the metrics configurations for the bucket."
"documentation":"<p>Lists the metrics configurations for the bucket.</p>"
},
"ListBuckets":{
"name":"ListBuckets",
@ -537,7 +537,7 @@
},
"output":{"shape":"ListBucketsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html",
"documentation":"Returns a list of all buckets owned by the authenticated sender of the request.",
"documentation":"<p>Returns a list of all buckets owned by the authenticated sender of the request.</p>",
"alias":"GetService"
},
"ListMultipartUploads":{
@ -549,7 +549,7 @@
"input":{"shape":"ListMultipartUploadsRequest"},
"output":{"shape":"ListMultipartUploadsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html",
"documentation":"This operation lists in-progress multipart uploads."
"documentation":"<p>This operation lists in-progress multipart uploads.</p>"
},
"ListObjectVersions":{
"name":"ListObjectVersions",
@ -560,7 +560,7 @@
"input":{"shape":"ListObjectVersionsRequest"},
"output":{"shape":"ListObjectVersionsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html",
"documentation":"Returns metadata about all of the versions of objects in a bucket.",
"documentation":"<p>Returns metadata about all of the versions of objects in a bucket.</p>",
"alias":"GetBucketObjectVersions"
},
"ListObjects":{
@ -575,7 +575,7 @@
{"shape":"NoSuchBucket"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html",
"documentation":"Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.",
"documentation":"<p>Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.</p>",
"alias":"GetBucket"
},
"ListObjectsV2":{
@ -589,7 +589,7 @@
"errors":[
{"shape":"NoSuchBucket"}
],
"documentation":"Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development."
"documentation":"<p>Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.</p>"
},
"ListParts":{
"name":"ListParts",
@ -600,7 +600,7 @@
"input":{"shape":"ListPartsRequest"},
"output":{"shape":"ListPartsOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html",
"documentation":"Lists the parts that have been uploaded for a specific multipart upload."
"documentation":"<p>Lists the parts that have been uploaded for a specific multipart upload.</p>"
},
"PutBucketAccelerateConfiguration":{
"name":"PutBucketAccelerateConfiguration",
@ -609,7 +609,7 @@
"requestUri":"/{Bucket}?accelerate"
},
"input":{"shape":"PutBucketAccelerateConfigurationRequest"},
"documentation":"Sets the accelerate configuration of an existing bucket."
"documentation":"<p>Sets the accelerate configuration of an existing bucket.</p>"
},
"PutBucketAcl":{
"name":"PutBucketAcl",
@ -619,7 +619,7 @@
},
"input":{"shape":"PutBucketAclRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html",
"documentation":"Sets the permissions on a bucket using access control lists (ACL)."
"documentation":"<p>Sets the permissions on a bucket using access control lists (ACL).</p>"
},
"PutBucketAnalyticsConfiguration":{
"name":"PutBucketAnalyticsConfiguration",
@ -628,7 +628,7 @@
"requestUri":"/{Bucket}?analytics"
},
"input":{"shape":"PutBucketAnalyticsConfigurationRequest"},
"documentation":"Sets an analytics configuration for the bucket (specified by the analytics configuration ID)."
"documentation":"<p>Sets an analytics configuration for the bucket (specified by the analytics configuration ID).</p>"
},
"PutBucketCors":{
"name":"PutBucketCors",
@ -638,7 +638,7 @@
},
"input":{"shape":"PutBucketCorsRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html",
"documentation":"Sets the cors configuration for a bucket."
"documentation":"<p>Sets the cors configuration for a bucket.</p>"
},
"PutBucketEncryption":{
"name":"PutBucketEncryption",
@ -647,7 +647,7 @@
"requestUri":"/{Bucket}?encryption"
},
"input":{"shape":"PutBucketEncryptionRequest"},
"documentation":"Creates a new server-side encryption configuration (or replaces an existing one, if present)."
"documentation":"<p>Creates a new server-side encryption configuration (or replaces an existing one, if present).</p>"
},
"PutBucketInventoryConfiguration":{
"name":"PutBucketInventoryConfiguration",
@ -656,7 +656,7 @@
"requestUri":"/{Bucket}?inventory"
},
"input":{"shape":"PutBucketInventoryConfigurationRequest"},
"documentation":"Adds an inventory configuration (identified by the inventory ID) from the bucket."
"documentation":"<p>Adds an inventory configuration (identified by the inventory ID) from the bucket.</p>"
},
"PutBucketLifecycle":{
"name":"PutBucketLifecycle",
@ -666,7 +666,7 @@
},
"input":{"shape":"PutBucketLifecycleRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html",
"documentation":"Deprecated, see the PutBucketLifecycleConfiguration operation.",
"documentation":"<p>Deprecated, see the PutBucketLifecycleConfiguration operation.</p>",
"deprecated":true
},
"PutBucketLifecycleConfiguration":{
@ -676,7 +676,7 @@
"requestUri":"/{Bucket}?lifecycle"
},
"input":{"shape":"PutBucketLifecycleConfigurationRequest"},
"documentation":"Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it."
"documentation":"<p>Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.</p>"
},
"PutBucketLogging":{
"name":"PutBucketLogging",
@ -686,7 +686,7 @@
},
"input":{"shape":"PutBucketLoggingRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html",
"documentation":"Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner."
"documentation":"<p>Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.</p>"
},
"PutBucketMetricsConfiguration":{
"name":"PutBucketMetricsConfiguration",
@ -695,7 +695,7 @@
"requestUri":"/{Bucket}?metrics"
},
"input":{"shape":"PutBucketMetricsConfigurationRequest"},
"documentation":"Sets a metrics configuration (specified by the metrics configuration ID) for the bucket."
"documentation":"<p>Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.</p>"
},
"PutBucketNotification":{
"name":"PutBucketNotification",
@ -705,7 +705,7 @@
},
"input":{"shape":"PutBucketNotificationRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html",
"documentation":"Deprecated, see the PutBucketNotificationConfiguraiton operation.",
"documentation":"<p>Deprecated, see the PutBucketNotificationConfiguraiton operation.</p>",
"deprecated":true
},
"PutBucketNotificationConfiguration":{
@ -715,7 +715,7 @@
"requestUri":"/{Bucket}?notification"
},
"input":{"shape":"PutBucketNotificationConfigurationRequest"},
"documentation":"Enables notifications of specified events for a bucket."
"documentation":"<p>Enables notifications of specified events for a bucket.</p>"
},
"PutBucketPolicy":{
"name":"PutBucketPolicy",
@ -725,7 +725,7 @@
},
"input":{"shape":"PutBucketPolicyRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html",
"documentation":"Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it."
"documentation":"<p>Replaces a policy on a bucket. If the bucket already has a policy, the one in this request completely replaces it.</p>"
},
"PutBucketReplication":{
"name":"PutBucketReplication",
@ -734,7 +734,7 @@
"requestUri":"/{Bucket}?replication"
},
"input":{"shape":"PutBucketReplicationRequest"},
"documentation":"Creates a new replication configuration (or replaces an existing one, if present)."
"documentation":"<p>Creates a new replication configuration (or replaces an existing one, if present).</p>"
},
"PutBucketRequestPayment":{
"name":"PutBucketRequestPayment",
@ -744,7 +744,7 @@
},
"input":{"shape":"PutBucketRequestPaymentRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html",
"documentation":"Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html"
"documentation":"<p>Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html</p>"
},
"PutBucketTagging":{
"name":"PutBucketTagging",
@ -754,7 +754,7 @@
},
"input":{"shape":"PutBucketTaggingRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html",
"documentation":"Sets the tags for a bucket."
"documentation":"<p>Sets the tags for a bucket.</p>"
},
"PutBucketVersioning":{
"name":"PutBucketVersioning",
@ -764,7 +764,7 @@
},
"input":{"shape":"PutBucketVersioningRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html",
"documentation":"Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner."
"documentation":"<p>Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.</p>"
},
"PutBucketWebsite":{
"name":"PutBucketWebsite",
@ -774,7 +774,7 @@
},
"input":{"shape":"PutBucketWebsiteRequest"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html",
"documentation":"Set the website configuration for a bucket."
"documentation":"<p>Set the website configuration for a bucket.</p>"
},
"PutObject":{
"name":"PutObject",
@ -785,7 +785,7 @@
"input":{"shape":"PutObjectRequest"},
"output":{"shape":"PutObjectOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html",
"documentation":"Adds an object to a bucket."
"documentation":"<p>Adds an object to a bucket.</p>"
},
"PutObjectAcl":{
"name":"PutObjectAcl",
@ -799,7 +799,7 @@
{"shape":"NoSuchKey"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html",
"documentation":"uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket"
"documentation":"<p>uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket</p>"
},
"PutObjectTagging":{
"name":"PutObjectTagging",
@ -809,7 +809,7 @@
},
"input":{"shape":"PutObjectTaggingRequest"},
"output":{"shape":"PutObjectTaggingOutput"},
"documentation":"Sets the supplied tag-set to an object that already exists in a bucket"
"documentation":"<p>Sets the supplied tag-set to an object that already exists in a bucket</p>"
},
"RestoreObject":{
"name":"RestoreObject",
@ -823,7 +823,7 @@
{"shape":"ObjectAlreadyInActiveTierError"}
],
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html",
"documentation":"Restores an archived copy of an object back into Amazon S3",
"documentation":"<p>Restores an archived copy of an object back into Amazon S3</p>",
"alias":"PostObjectRestore"
},
"SelectObjectContent":{
@ -838,7 +838,7 @@
"xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}
},
"output":{"shape":"SelectObjectContentOutput"},
"documentation":"This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response."
"documentation":"<p>This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.</p>"
},
"UploadPart":{
"name":"UploadPart",
@ -849,7 +849,7 @@
"input":{"shape":"UploadPartRequest"},
"output":{"shape":"UploadPartOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html",
"documentation":"<p>Uploads a part in a multipart upload.</p><p><b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p>"
"documentation":"<p>Uploads a part in a multipart upload.</p> <p> <b>Note:</b> After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.</p>"
},
"UploadPartCopy":{
"name":"UploadPartCopy",
@ -860,7 +860,7 @@
"input":{"shape":"UploadPartCopyRequest"},
"output":{"shape":"UploadPartCopyOutput"},
"documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html",
"documentation":"Uploads a part by copying data from an existing object as data source."
"documentation":"<p>Uploads a part by copying data from an existing object as data source.</p>"
}
},
"shapes":{
@ -870,10 +870,10 @@
"members":{
"DaysAfterInitiation":{
"shape":"DaysAfterInitiation",
"documentation":"Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload."
"documentation":"<p>Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload.</p>"
}
},
"documentation":"Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload."
"documentation":"<p>Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.</p>"
},
"AbortMultipartUploadOutput":{
"type":"structure",
@ -921,7 +921,7 @@
"members":{
"Status":{
"shape":"BucketAccelerateStatus",
"documentation":"The accelerate configuration of the bucket."
"documentation":"<p>The accelerate configuration of the bucket.</p>"
}
}
},
@ -931,7 +931,7 @@
"members":{
"Grants":{
"shape":"Grants",
"documentation":"A list of grants.",
"documentation":"<p>A list of grants.</p>",
"locationName":"AccessControlList"
},
"Owner":{"shape":"Owner"}
@ -943,10 +943,10 @@
"members":{
"Owner":{
"shape":"OwnerOverride",
"documentation":"The override value for the owner of the replica object."
"documentation":"<p>The override value for the owner of the replica object.</p>"
}
},
"documentation":"Container for information regarding the access control for replicas."
"documentation":"<p>Container for information regarding the access control for replicas.</p>"
},
"AccountId":{"type":"string"},
"AllowQuotedRecordDelimiter":{"type":"boolean"},
@ -973,11 +973,11 @@
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"The prefix to use when evaluating an AND predicate."
"documentation":"<p>The prefix to use when evaluating an AND predicate.</p>"
},
"Tags":{
"shape":"TagSet",
"documentation":"The list of tags to use when evaluating an AND predicate.",
"documentation":"<p>The list of tags to use when evaluating an AND predicate.</p>",
"flattened":true,
"locationName":"Tag"
}
@ -992,15 +992,15 @@
"members":{
"Id":{
"shape":"AnalyticsId",
"documentation":"The identifier used to represent an analytics configuration."
"documentation":"<p>The identifier used to represent an analytics configuration.</p>"
},
"Filter":{
"shape":"AnalyticsFilter",
"documentation":"The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis."
"documentation":"<p>The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.</p>"
},
"StorageClassAnalysis":{
"shape":"StorageClassAnalysis",
"documentation":"If present, it indicates that data related to access patterns will be collected and made available to analyze the tradeoffs between different storage classes."
"documentation":"<p>If present, it indicates that data related to access patterns will be collected and made available to analyze the tradeoffs between different storage classes.</p>"
}
}
},
@ -1015,7 +1015,7 @@
"members":{
"S3BucketDestination":{
"shape":"AnalyticsS3BucketDestination",
"documentation":"A destination signifying output to an S3 bucket."
"documentation":"<p>A destination signifying output to an S3 bucket.</p>"
}
}
},
@ -1024,15 +1024,15 @@
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"The prefix to use when evaluating an analytics filter."
"documentation":"<p>The prefix to use when evaluating an analytics filter.</p>"
},
"Tag":{
"shape":"Tag",
"documentation":"The tag to use when evaluating an analytics filter."
"documentation":"<p>The tag to use when evaluating an analytics filter.</p>"
},
"And":{
"shape":"AnalyticsAndOperator",
"documentation":"A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates."
"documentation":"<p>A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.</p>"
}
}
},
@ -1046,19 +1046,19 @@
"members":{
"Format":{
"shape":"AnalyticsS3ExportFileFormat",
"documentation":"The file format used when exporting data to Amazon S3."
"documentation":"<p>The file format used when exporting data to Amazon S3.</p>"
},
"BucketAccountId":{
"shape":"AccountId",
"documentation":"The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data."
"documentation":"<p>The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data.</p>"
},
"Bucket":{
"shape":"BucketName",
"documentation":"The Amazon resource name (ARN) of the bucket to which data is exported."
"documentation":"<p>The Amazon resource name (ARN) of the bucket to which data is exported.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"The prefix to use when exporting data. The exported data begins with this prefix."
"documentation":"<p>The prefix to use when exporting data. The exported data begins with this prefix.</p>"
}
}
},
@ -1072,11 +1072,11 @@
"members":{
"Name":{
"shape":"BucketName",
"documentation":"The name of the bucket."
"documentation":"<p>The name of the bucket.</p>"
},
"CreationDate":{
"shape":"CreationDate",
"documentation":"Date the bucket was created."
"documentation":"<p>Date the bucket was created.</p>"
}
}
},
@ -1091,7 +1091,7 @@
"type":"structure",
"members":{
},
"documentation":"The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.",
"documentation":"<p>The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.</p>",
"exception":true
},
"BucketAlreadyOwnedByYou":{
@ -1186,27 +1186,27 @@
"members":{
"AllowedHeaders":{
"shape":"AllowedHeaders",
"documentation":"Specifies which headers are allowed in a pre-flight OPTIONS request.",
"documentation":"<p>Specifies which headers are allowed in a pre-flight OPTIONS request.</p>",
"locationName":"AllowedHeader"
},
"AllowedMethods":{
"shape":"AllowedMethods",
"documentation":"Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.",
"documentation":"<p>Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.</p>",
"locationName":"AllowedMethod"
},
"AllowedOrigins":{
"shape":"AllowedOrigins",
"documentation":"One or more origins you want customers to be able to access the bucket from.",
"documentation":"<p>One or more origins you want customers to be able to access the bucket from.</p>",
"locationName":"AllowedOrigin"
},
"ExposeHeaders":{
"shape":"ExposeHeaders",
"documentation":"One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).",
"documentation":"<p>One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).</p>",
"locationName":"ExposeHeader"
},
"MaxAgeSeconds":{
"shape":"MaxAgeSeconds",
"documentation":"The time in seconds that your browser is to cache the preflight response for the specified resource."
"documentation":"<p>The time in seconds that your browser is to cache the preflight response for the specified resource.</p>"
}
}
},
@ -1220,60 +1220,60 @@
"members":{
"FileHeaderInfo":{
"shape":"FileHeaderInfo",
"documentation":"Describes the first line of input. Valid values: None, Ignore, Use."
"documentation":"<p>Describes the first line of input. Valid values: None, Ignore, Use.</p>"
},
"Comments":{
"shape":"Comments",
"documentation":"Single character used to indicate a row should be ignored when present at the start of a row."
"documentation":"<p>Single character used to indicate a row should be ignored when present at the start of a row.</p>"
},
"QuoteEscapeCharacter":{
"shape":"QuoteEscapeCharacter",
"documentation":"Single character used for escaping the quote character inside an already escaped value."
"documentation":"<p>Single character used for escaping the quote character inside an already escaped value.</p>"
},
"RecordDelimiter":{
"shape":"RecordDelimiter",
"documentation":"Value used to separate individual records."
"documentation":"<p>Value used to separate individual records.</p>"
},
"FieldDelimiter":{
"shape":"FieldDelimiter",
"documentation":"Value used to separate individual fields in a record."
"documentation":"<p>Value used to separate individual fields in a record.</p>"
},
"QuoteCharacter":{
"shape":"QuoteCharacter",
"documentation":"Value used for escaping where the field delimiter is part of the value."
"documentation":"<p>Value used for escaping where the field delimiter is part of the value.</p>"
},
"AllowQuotedRecordDelimiter":{
"shape":"AllowQuotedRecordDelimiter",
"documentation":"Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance."
"documentation":"<p>Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.</p>"
}
},
"documentation":"Describes how a CSV-formatted input object is formatted."
"documentation":"<p>Describes how a CSV-formatted input object is formatted.</p>"
},
"CSVOutput":{
"type":"structure",
"members":{
"QuoteFields":{
"shape":"QuoteFields",
"documentation":"Indicates whether or not all output fields should be quoted."
"documentation":"<p>Indicates whether or not all output fields should be quoted.</p>"
},
"QuoteEscapeCharacter":{
"shape":"QuoteEscapeCharacter",
"documentation":"Single character used for escaping the quote character inside an already escaped value."
"documentation":"<p>Single character used for escaping the quote character inside an already escaped value.</p>"
},
"RecordDelimiter":{
"shape":"RecordDelimiter",
"documentation":"Value used to separate individual records."
"documentation":"<p>Value used to separate individual records.</p>"
},
"FieldDelimiter":{
"shape":"FieldDelimiter",
"documentation":"Value used to separate individual fields in a record."
"documentation":"<p>Value used to separate individual fields in a record.</p>"
},
"QuoteCharacter":{
"shape":"QuoteCharacter",
"documentation":"Value used for escaping where the field delimiter is part of the value."
"documentation":"<p>Value used for escaping where the field delimiter is part of the value.</p>"
}
},
"documentation":"Describes how CSV-formatted results are formatted."
"documentation":"<p>Describes how CSV-formatted results are formatted.</p>"
},
"CacheControl":{"type":"string"},
"CloudFunction":{"type":"string"},
@ -1315,29 +1315,29 @@
"Key":{"shape":"ObjectKey"},
"Expiration":{
"shape":"Expiration",
"documentation":"If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.",
"documentation":"<p>If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
"ETag":{
"shape":"ETag",
"documentation":"Entity tag of the object."
"documentation":"<p>Entity tag of the object.</p>"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Version of the object.",
"documentation":"<p>Version of the object.</p>",
"location":"header",
"locationName":"x-amz-version-id"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -1398,11 +1398,11 @@
"members":{
"ETag":{
"shape":"ETag",
"documentation":"Entity tag returned when the part was uploaded."
"documentation":"<p>Entity tag returned when the part was uploaded.</p>"
},
"PartNumber":{
"shape":"PartNumber",
"documentation":"Part number that identifies the part. This is a positive integer between 1 and 10,000."
"documentation":"<p>Part number that identifies the part. This is a positive integer between 1 and 10,000.</p>"
}
}
},
@ -1415,7 +1415,8 @@
"type":"string",
"enum":[
"NONE",
"GZIP"
"GZIP",
"BZIP2"
]
},
"Condition":{
@ -1423,11 +1424,11 @@
"members":{
"HttpErrorCodeReturnedEquals":{
"shape":"HttpErrorCodeReturnedEquals",
"documentation":"The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied."
"documentation":"<p>The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.</p>"
},
"KeyPrefixEquals":{
"shape":"KeyPrefixEquals",
"documentation":"The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied."
"documentation":"<p>The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.</p>"
}
}
},
@ -1451,7 +1452,7 @@
"CopyObjectResult":{"shape":"CopyObjectResult"},
"Expiration":{
"shape":"Expiration",
"documentation":"If the object expiration is configured, the response includes this header.",
"documentation":"<p>If the object expiration is configured, the response includes this header.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
@ -1462,31 +1463,31 @@
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Version ID of the newly created copy.",
"documentation":"<p>Version ID of the newly created copy.</p>",
"location":"header",
"locationName":"x-amz-version-id"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -1508,7 +1509,7 @@
"members":{
"ACL":{
"shape":"ObjectCannedACL",
"documentation":"The canned ACL to apply to the object.",
"documentation":"<p>The canned ACL to apply to the object.</p>",
"location":"header",
"locationName":"x-amz-acl"
},
@ -1519,91 +1520,91 @@
},
"CacheControl":{
"shape":"CacheControl",
"documentation":"Specifies caching behavior along the request/reply chain.",
"documentation":"<p>Specifies caching behavior along the request/reply chain.</p>",
"location":"header",
"locationName":"Cache-Control"
},
"ContentDisposition":{
"shape":"ContentDisposition",
"documentation":"Specifies presentational information for the object.",
"documentation":"<p>Specifies presentational information for the object.</p>",
"location":"header",
"locationName":"Content-Disposition"
},
"ContentEncoding":{
"shape":"ContentEncoding",
"documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.",
"documentation":"<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location":"header",
"locationName":"Content-Encoding"
},
"ContentLanguage":{
"shape":"ContentLanguage",
"documentation":"The language the content is in.",
"documentation":"<p>The language the content is in.</p>",
"location":"header",
"locationName":"Content-Language"
},
"ContentType":{
"shape":"ContentType",
"documentation":"A standard MIME type describing the format of the object data.",
"documentation":"<p>A standard MIME type describing the format of the object data.</p>",
"location":"header",
"locationName":"Content-Type"
},
"CopySource":{
"shape":"CopySource",
"documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.",
"documentation":"<p>The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.</p>",
"location":"header",
"locationName":"x-amz-copy-source"
},
"CopySourceIfMatch":{
"shape":"CopySourceIfMatch",
"documentation":"Copies the object if its entity tag (ETag) matches the specified tag.",
"documentation":"<p>Copies the object if its entity tag (ETag) matches the specified tag.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-match"
},
"CopySourceIfModifiedSince":{
"shape":"CopySourceIfModifiedSince",
"documentation":"Copies the object if it has been modified since the specified time.",
"documentation":"<p>Copies the object if it has been modified since the specified time.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-modified-since"
},
"CopySourceIfNoneMatch":{
"shape":"CopySourceIfNoneMatch",
"documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag.",
"documentation":"<p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-none-match"
},
"CopySourceIfUnmodifiedSince":{
"shape":"CopySourceIfUnmodifiedSince",
"documentation":"Copies the object if it hasn't been modified since the specified time.",
"documentation":"<p>Copies the object if it hasn't been modified since the specified time.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-unmodified-since"
},
"Expires":{
"shape":"Expires",
"documentation":"The date and time at which the object is no longer cacheable.",
"documentation":"<p>The date and time at which the object is no longer cacheable.</p>",
"location":"header",
"locationName":"Expires"
},
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.",
"documentation":"<p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>",
"location":"header",
"locationName":"x-amz-grant-full-control"
},
"GrantRead":{
"shape":"GrantRead",
"documentation":"Allows grantee to read the object data and its metadata.",
"documentation":"<p>Allows grantee to read the object data and its metadata.</p>",
"location":"header",
"locationName":"x-amz-grant-read"
},
"GrantReadACP":{
"shape":"GrantReadACP",
"documentation":"Allows grantee to read the object ACL.",
"documentation":"<p>Allows grantee to read the object ACL.</p>",
"location":"header",
"locationName":"x-amz-grant-read-acp"
},
"GrantWriteACP":{
"shape":"GrantWriteACP",
"documentation":"Allows grantee to write the ACL for the applicable object.",
"documentation":"<p>Allows grantee to write the ACL for the applicable object.</p>",
"location":"header",
"locationName":"x-amz-grant-write-acp"
},
@ -1614,79 +1615,79 @@
},
"Metadata":{
"shape":"Metadata",
"documentation":"A map of metadata to store with the object in S3.",
"documentation":"<p>A map of metadata to store with the object in S3.</p>",
"location":"headers",
"locationName":"x-amz-meta-"
},
"MetadataDirective":{
"shape":"MetadataDirective",
"documentation":"Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.",
"documentation":"<p>Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.</p>",
"location":"header",
"locationName":"x-amz-metadata-directive"
},
"TaggingDirective":{
"shape":"TaggingDirective",
"documentation":"Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.",
"documentation":"<p>Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.</p>",
"location":"header",
"locationName":"x-amz-tagging-directive"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"StorageClass":{
"shape":"StorageClass",
"documentation":"The type of storage to use for the object. Defaults to 'STANDARD'.",
"documentation":"<p>The type of storage to use for the object. Defaults to 'STANDARD'.</p>",
"location":"header",
"locationName":"x-amz-storage-class"
},
"WebsiteRedirectLocation":{
"shape":"WebsiteRedirectLocation",
"documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.",
"documentation":"<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location":"header",
"locationName":"x-amz-website-redirect-location"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version",
"documentation":"<p>Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
"CopySourceSSECustomerAlgorithm":{
"shape":"CopySourceSSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use when decrypting the source object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm"
},
"CopySourceSSECustomerKey":{
"shape":"CopySourceSSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.</p>",
"location":"header",
"locationName":"x-amz-copy-source-server-side-encryption-customer-key"
},
"CopySourceSSECustomerKeyMD5":{
"shape":"CopySourceSSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5"
},
@ -1697,7 +1698,7 @@
},
"Tagging":{
"shape":"TaggingHeader",
"documentation":"The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters",
"documentation":"<p>The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters</p>",
"location":"header",
"locationName":"x-amz-tagging"
}
@ -1715,11 +1716,11 @@
"members":{
"ETag":{
"shape":"ETag",
"documentation":"Entity tag of the object."
"documentation":"<p>Entity tag of the object.</p>"
},
"LastModified":{
"shape":"LastModified",
"documentation":"Date and time at which the object was uploaded."
"documentation":"<p>Date and time at which the object was uploaded.</p>"
}
}
},
@ -1744,7 +1745,7 @@
"members":{
"LocationConstraint":{
"shape":"BucketLocationConstraint",
"documentation":"Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard."
"documentation":"<p>Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard.</p>"
}
}
},
@ -1764,7 +1765,7 @@
"members":{
"ACL":{
"shape":"BucketCannedACL",
"documentation":"The canned ACL to apply to the bucket.",
"documentation":"<p>The canned ACL to apply to the bucket.</p>",
"location":"header",
"locationName":"x-amz-acl"
},
@ -1780,31 +1781,31 @@
},
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.",
"documentation":"<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-full-control"
},
"GrantRead":{
"shape":"GrantRead",
"documentation":"Allows grantee to list the objects in the bucket.",
"documentation":"<p>Allows grantee to list the objects in the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-read"
},
"GrantReadACP":{
"shape":"GrantReadACP",
"documentation":"Allows grantee to read the bucket ACL.",
"documentation":"<p>Allows grantee to read the bucket ACL.</p>",
"location":"header",
"locationName":"x-amz-grant-read-acp"
},
"GrantWrite":{
"shape":"GrantWrite",
"documentation":"Allows grantee to create, overwrite, and delete any object in the bucket.",
"documentation":"<p>Allows grantee to create, overwrite, and delete any object in the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-write"
},
"GrantWriteACP":{
"shape":"GrantWriteACP",
"documentation":"Allows grantee to write the ACL for the applicable bucket.",
"documentation":"<p>Allows grantee to write the ACL for the applicable bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-write-acp"
}
@ -1816,50 +1817,50 @@
"members":{
"AbortDate":{
"shape":"AbortDate",
"documentation":"Date when multipart upload will become eligible for abort operation by lifecycle.",
"documentation":"<p>Date when multipart upload will become eligible for abort operation by lifecycle.</p>",
"location":"header",
"locationName":"x-amz-abort-date"
},
"AbortRuleId":{
"shape":"AbortRuleId",
"documentation":"Id of the lifecycle rule that makes a multipart upload eligible for abort operation.",
"documentation":"<p>Id of the lifecycle rule that makes a multipart upload eligible for abort operation.</p>",
"location":"header",
"locationName":"x-amz-abort-rule-id"
},
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket to which the multipart upload was initiated.",
"documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p>",
"locationName":"Bucket"
},
"Key":{
"shape":"ObjectKey",
"documentation":"Object key for which the multipart upload was initiated."
"documentation":"<p>Object key for which the multipart upload was initiated.</p>"
},
"UploadId":{
"shape":"MultipartUploadId",
"documentation":"ID for the initiated multipart upload."
"documentation":"<p>ID for the initiated multipart upload.</p>"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -1879,7 +1880,7 @@
"members":{
"ACL":{
"shape":"ObjectCannedACL",
"documentation":"The canned ACL to apply to the object.",
"documentation":"<p>The canned ACL to apply to the object.</p>",
"location":"header",
"locationName":"x-amz-acl"
},
@ -1890,61 +1891,61 @@
},
"CacheControl":{
"shape":"CacheControl",
"documentation":"Specifies caching behavior along the request/reply chain.",
"documentation":"<p>Specifies caching behavior along the request/reply chain.</p>",
"location":"header",
"locationName":"Cache-Control"
},
"ContentDisposition":{
"shape":"ContentDisposition",
"documentation":"Specifies presentational information for the object.",
"documentation":"<p>Specifies presentational information for the object.</p>",
"location":"header",
"locationName":"Content-Disposition"
},
"ContentEncoding":{
"shape":"ContentEncoding",
"documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.",
"documentation":"<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location":"header",
"locationName":"Content-Encoding"
},
"ContentLanguage":{
"shape":"ContentLanguage",
"documentation":"The language the content is in.",
"documentation":"<p>The language the content is in.</p>",
"location":"header",
"locationName":"Content-Language"
},
"ContentType":{
"shape":"ContentType",
"documentation":"A standard MIME type describing the format of the object data.",
"documentation":"<p>A standard MIME type describing the format of the object data.</p>",
"location":"header",
"locationName":"Content-Type"
},
"Expires":{
"shape":"Expires",
"documentation":"The date and time at which the object is no longer cacheable.",
"documentation":"<p>The date and time at which the object is no longer cacheable.</p>",
"location":"header",
"locationName":"Expires"
},
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.",
"documentation":"<p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>",
"location":"header",
"locationName":"x-amz-grant-full-control"
},
"GrantRead":{
"shape":"GrantRead",
"documentation":"Allows grantee to read the object data and its metadata.",
"documentation":"<p>Allows grantee to read the object data and its metadata.</p>",
"location":"header",
"locationName":"x-amz-grant-read"
},
"GrantReadACP":{
"shape":"GrantReadACP",
"documentation":"Allows grantee to read the object ACL.",
"documentation":"<p>Allows grantee to read the object ACL.</p>",
"location":"header",
"locationName":"x-amz-grant-read-acp"
},
"GrantWriteACP":{
"shape":"GrantWriteACP",
"documentation":"Allows grantee to write the ACL for the applicable object.",
"documentation":"<p>Allows grantee to write the ACL for the applicable object.</p>",
"location":"header",
"locationName":"x-amz-grant-write-acp"
},
@ -1955,49 +1956,49 @@
},
"Metadata":{
"shape":"Metadata",
"documentation":"A map of metadata to store with the object in S3.",
"documentation":"<p>A map of metadata to store with the object in S3.</p>",
"location":"headers",
"locationName":"x-amz-meta-"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"StorageClass":{
"shape":"StorageClass",
"documentation":"The type of storage to use for the object. Defaults to 'STANDARD'.",
"documentation":"<p>The type of storage to use for the object. Defaults to 'STANDARD'.</p>",
"location":"header",
"locationName":"x-amz-storage-class"
},
"WebsiteRedirectLocation":{
"shape":"WebsiteRedirectLocation",
"documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.",
"documentation":"<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location":"header",
"locationName":"x-amz-website-redirect-location"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version",
"documentation":"<p>Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -2008,7 +2009,7 @@
},
"Tagging":{
"shape":"TaggingHeader",
"documentation":"The tag-set for the object. The tag-set must be encoded as URL Query parameters",
"documentation":"<p>The tag-set for the object. The tag-set must be encoded as URL Query parameters</p>",
"location":"header",
"locationName":"x-amz-tagging"
}
@ -2031,7 +2032,7 @@
},
"Quiet":{
"shape":"Quiet",
"documentation":"Element to enable quiet mode for the request. When you add this element, you must set its value to true."
"documentation":"<p>Element to enable quiet mode for the request. When you add this element, you must set its value to true.</p>"
}
}
},
@ -2044,13 +2045,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket from which an analytics configuration is deleted.",
"documentation":"<p>The name of the bucket from which an analytics configuration is deleted.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"AnalyticsId",
"documentation":"The identifier used to represent an analytics configuration.",
"documentation":"<p>The identifier used to represent an analytics configuration.</p>",
"location":"querystring",
"locationName":"id"
}
@ -2073,7 +2074,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket containing the server-side encryption configuration to delete.",
"documentation":"<p>The name of the bucket containing the server-side encryption configuration to delete.</p>",
"location":"uri",
"locationName":"Bucket"
}
@ -2088,13 +2089,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket containing the inventory configuration to delete.",
"documentation":"<p>The name of the bucket containing the inventory configuration to delete.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"InventoryId",
"documentation":"The ID used to identify the inventory configuration.",
"documentation":"<p>The ID used to identify the inventory configuration.</p>",
"location":"querystring",
"locationName":"id"
}
@ -2120,13 +2121,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket containing the metrics configuration to delete.",
"documentation":"<p>The name of the bucket containing the metrics configuration to delete.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"MetricsId",
"documentation":"The ID used to identify the metrics configuration.",
"documentation":"<p>The ID used to identify the metrics configuration.</p>",
"location":"querystring",
"locationName":"id"
}
@ -2194,19 +2195,19 @@
"Owner":{"shape":"Owner"},
"Key":{
"shape":"ObjectKey",
"documentation":"The object key."
"documentation":"<p>The object key.</p>"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Version ID of an object."
"documentation":"<p>Version ID of an object.</p>"
},
"IsLatest":{
"shape":"IsLatest",
"documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object."
"documentation":"<p>Specifies whether the object is (true) or is not (false) the latest version of an object.</p>"
},
"LastModified":{
"shape":"LastModified",
"documentation":"Date and time the object was last modified."
"documentation":"<p>Date and time the object was last modified.</p>"
}
}
},
@ -2221,13 +2222,13 @@
"members":{
"DeleteMarker":{
"shape":"DeleteMarker",
"documentation":"Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.",
"documentation":"<p>Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.</p>",
"location":"header",
"locationName":"x-amz-delete-marker"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Returns the version ID of the delete marker created as a result of the DELETE operation.",
"documentation":"<p>Returns the version ID of the delete marker created as a result of the DELETE operation.</p>",
"location":"header",
"locationName":"x-amz-version-id"
},
@ -2257,13 +2258,13 @@
},
"MFA":{
"shape":"MFA",
"documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.",
"documentation":"<p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.</p>",
"location":"header",
"locationName":"x-amz-mfa"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"VersionId used to reference a specific version of the object.",
"documentation":"<p>VersionId used to reference a specific version of the object.</p>",
"location":"querystring",
"locationName":"versionId"
},
@ -2279,7 +2280,7 @@
"members":{
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"The versionId of the object the tag-set was removed from.",
"documentation":"<p>The versionId of the object the tag-set was removed from.</p>",
"location":"header",
"locationName":"x-amz-version-id"
}
@ -2304,7 +2305,7 @@
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"The versionId of the object that the tag-set will be removed from.",
"documentation":"<p>The versionId of the object that the tag-set will be removed from.</p>",
"location":"querystring",
"locationName":"versionId"
}
@ -2344,7 +2345,7 @@
},
"MFA":{
"shape":"MFA",
"documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.",
"documentation":"<p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.</p>",
"location":"header",
"locationName":"x-amz-mfa"
},
@ -2378,26 +2379,26 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule."
"documentation":"<p>Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.</p>"
},
"Account":{
"shape":"AccountId",
"documentation":"Account ID of the destination bucket. Currently this is only being verified if Access Control Translation is enabled"
"documentation":"<p>Account ID of the destination bucket. Currently this is only being verified if Access Control Translation is enabled</p>"
},
"StorageClass":{
"shape":"StorageClass",
"documentation":"The class of storage used to store the object."
"documentation":"<p>The class of storage used to store the object.</p>"
},
"AccessControlTranslation":{
"shape":"AccessControlTranslation",
"documentation":"Container for information regarding the access control for replicas."
"documentation":"<p>Container for information regarding the access control for replicas.</p>"
},
"EncryptionConfiguration":{
"shape":"EncryptionConfiguration",
"documentation":"Container for information regarding encryption based configuration for replicas."
"documentation":"<p>Container for information regarding encryption based configuration for replicas.</p>"
}
},
"documentation":"Container for replication destination information."
"documentation":"<p>Container for replication destination information.</p>"
},
"DisplayName":{"type":"string"},
"ETag":{"type":"string"},
@ -2405,7 +2406,7 @@
"EnableRequestProgress":{"type":"boolean"},
"EncodingType":{
"type":"string",
"documentation":"Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.",
"documentation":"<p>Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.</p>",
"enum":["url"]
},
"Encryption":{
@ -2414,28 +2415,28 @@
"members":{
"EncryptionType":{
"shape":"ServerSideEncryption",
"documentation":"The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms)."
"documentation":"<p>The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms).</p>"
},
"KMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If the encryption type is aws:kms, this optional value specifies the AWS KMS key ID to use for encryption of job results."
"documentation":"<p>If the encryption type is aws:kms, this optional value specifies the AWS KMS key ID to use for encryption of job results.</p>"
},
"KMSContext":{
"shape":"KMSContext",
"documentation":"If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results."
"documentation":"<p>If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.</p>"
}
},
"documentation":"Describes the server-side encryption that will be applied to the restore results."
"documentation":"<p>Describes the server-side encryption that will be applied to the restore results.</p>"
},
"EncryptionConfiguration":{
"type":"structure",
"members":{
"ReplicaKmsKeyID":{
"shape":"ReplicaKmsKeyID",
"documentation":"The id of the KMS key used to encrypt the replica object."
"documentation":"<p>The id of the KMS key used to encrypt the replica object.</p>"
}
},
"documentation":"Container for information regarding encryption based configuration for replicas."
"documentation":"<p>Container for information regarding encryption based configuration for replicas.</p>"
},
"EndEvent":{
"type":"structure",
@ -2458,7 +2459,7 @@
"members":{
"Key":{
"shape":"ObjectKey",
"documentation":"The object key name to use when a 4XX class error occurs."
"documentation":"<p>The object key name to use when a 4XX class error occurs.</p>"
}
}
},
@ -2469,7 +2470,7 @@
},
"Event":{
"type":"string",
"documentation":"Bucket event for which to send notifications.",
"documentation":"<p>Bucket event for which to send notifications.</p>",
"enum":[
"s3:ReducedRedundancyLostObject",
"s3:ObjectCreated:*",
@ -2523,16 +2524,16 @@
"members":{
"Name":{
"shape":"FilterRuleName",
"documentation":"Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a> in the Amazon Simple Storage Service Developer Guide."
"documentation":"<p>Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a> in the Amazon Simple Storage Service Developer Guide.</p>"
},
"Value":{"shape":"FilterRuleValue"}
},
"documentation":"Container for key value pair that defines the criteria for the filter rule."
"documentation":"<p>Container for key value pair that defines the criteria for the filter rule.</p>"
},
"FilterRuleList":{
"type":"list",
"member":{"shape":"FilterRule"},
"documentation":"A list of containers for key value pair that defines the criteria for the filter rule.",
"documentation":"<p>A list of containers for key value pair that defines the criteria for the filter rule.</p>",
"flattened":true
},
"FilterRuleName":{
@ -2548,7 +2549,7 @@
"members":{
"Status":{
"shape":"BucketAccelerateStatus",
"documentation":"The accelerate configuration of the bucket."
"documentation":"<p>The accelerate configuration of the bucket.</p>"
}
}
},
@ -2558,7 +2559,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket for which the accelerate configuration is retrieved.",
"documentation":"<p>Name of the bucket for which the accelerate configuration is retrieved.</p>",
"location":"uri",
"locationName":"Bucket"
}
@ -2570,7 +2571,7 @@
"Owner":{"shape":"Owner"},
"Grants":{
"shape":"Grants",
"documentation":"A list of grants.",
"documentation":"<p>A list of grants.</p>",
"locationName":"AccessControlList"
}
}
@ -2591,7 +2592,7 @@
"members":{
"AnalyticsConfiguration":{
"shape":"AnalyticsConfiguration",
"documentation":"The configuration and any analyses for the analytics filter."
"documentation":"<p>The configuration and any analyses for the analytics filter.</p>"
}
},
"payload":"AnalyticsConfiguration"
@ -2605,13 +2606,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket from which an analytics configuration is retrieved.",
"documentation":"<p>The name of the bucket from which an analytics configuration is retrieved.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"AnalyticsId",
"documentation":"The identifier used to represent an analytics configuration.",
"documentation":"<p>The identifier used to represent an analytics configuration.</p>",
"location":"querystring",
"locationName":"id"
}
@ -2650,7 +2651,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket from which the server-side encryption configuration is retrieved.",
"documentation":"<p>The name of the bucket from which the server-side encryption configuration is retrieved.</p>",
"location":"uri",
"locationName":"Bucket"
}
@ -2661,7 +2662,7 @@
"members":{
"InventoryConfiguration":{
"shape":"InventoryConfiguration",
"documentation":"Specifies the inventory configuration."
"documentation":"<p>Specifies the inventory configuration.</p>"
}
},
"payload":"InventoryConfiguration"
@ -2675,13 +2676,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket containing the inventory configuration to retrieve.",
"documentation":"<p>The name of the bucket containing the inventory configuration to retrieve.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"InventoryId",
"documentation":"The ID used to identify the inventory configuration.",
"documentation":"<p>The ID used to identify the inventory configuration.</p>",
"location":"querystring",
"locationName":"id"
}
@ -2766,7 +2767,7 @@
"members":{
"MetricsConfiguration":{
"shape":"MetricsConfiguration",
"documentation":"Specifies the metrics configuration."
"documentation":"<p>Specifies the metrics configuration.</p>"
}
},
"payload":"MetricsConfiguration"
@ -2780,13 +2781,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket containing the metrics configuration to retrieve.",
"documentation":"<p>The name of the bucket containing the metrics configuration to retrieve.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"MetricsId",
"documentation":"The ID used to identify the metrics configuration.",
"documentation":"<p>The ID used to identify the metrics configuration.</p>",
"location":"querystring",
"locationName":"id"
}
@ -2798,7 +2799,7 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket to get the notification configuration for.",
"documentation":"<p>Name of the bucket to get the notification configuration for.</p>",
"location":"uri",
"locationName":"Bucket"
}
@ -2809,7 +2810,7 @@
"members":{
"Policy":{
"shape":"Policy",
"documentation":"The bucket policy as a JSON document."
"documentation":"<p>The bucket policy as a JSON document.</p>"
}
},
"payload":"Policy"
@ -2848,7 +2849,7 @@
"members":{
"Payer":{
"shape":"Payer",
"documentation":"Specifies who pays for the download and request fees."
"documentation":"<p>Specifies who pays for the download and request fees.</p>"
}
}
},
@ -2886,11 +2887,11 @@
"members":{
"Status":{
"shape":"BucketVersioningStatus",
"documentation":"The versioning state of the bucket."
"documentation":"<p>The versioning state of the bucket.</p>"
},
"MFADelete":{
"shape":"MFADeleteStatus",
"documentation":"Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.",
"documentation":"<p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.</p>",
"locationName":"MfaDelete"
}
}
@ -2932,7 +2933,7 @@
"Owner":{"shape":"Owner"},
"Grants":{
"shape":"Grants",
"documentation":"A list of grants.",
"documentation":"<p>A list of grants.</p>",
"locationName":"AccessControlList"
},
"RequestCharged":{
@ -2961,7 +2962,7 @@
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"VersionId used to reference a specific version of the object.",
"documentation":"<p>VersionId used to reference a specific version of the object.</p>",
"location":"querystring",
"locationName":"versionId"
},
@ -2977,12 +2978,12 @@
"members":{
"Body":{
"shape":"Body",
"documentation":"Object data.",
"documentation":"<p>Object data.</p>",
"streaming":true
},
"DeleteMarker":{
"shape":"DeleteMarker",
"documentation":"Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.",
"documentation":"<p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p>",
"location":"header",
"locationName":"x-amz-delete-marker"
},
@ -2993,121 +2994,121 @@
},
"Expiration":{
"shape":"Expiration",
"documentation":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.",
"documentation":"<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
"Restore":{
"shape":"Restore",
"documentation":"Provides information about object restoration operation and expiration time of the restored object copy.",
"documentation":"<p>Provides information about object restoration operation and expiration time of the restored object copy.</p>",
"location":"header",
"locationName":"x-amz-restore"
},
"LastModified":{
"shape":"LastModified",
"documentation":"Last modified date of the object",
"documentation":"<p>Last modified date of the object</p>",
"location":"header",
"locationName":"Last-Modified"
},
"ContentLength":{
"shape":"ContentLength",
"documentation":"Size of the body in bytes.",
"documentation":"<p>Size of the body in bytes.</p>",
"location":"header",
"locationName":"Content-Length"
},
"ETag":{
"shape":"ETag",
"documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL",
"documentation":"<p>An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL</p>",
"location":"header",
"locationName":"ETag"
},
"MissingMeta":{
"shape":"MissingMeta",
"documentation":"This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.",
"documentation":"<p>This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.</p>",
"location":"header",
"locationName":"x-amz-missing-meta"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Version of the object.",
"documentation":"<p>Version of the object.</p>",
"location":"header",
"locationName":"x-amz-version-id"
},
"CacheControl":{
"shape":"CacheControl",
"documentation":"Specifies caching behavior along the request/reply chain.",
"documentation":"<p>Specifies caching behavior along the request/reply chain.</p>",
"location":"header",
"locationName":"Cache-Control"
},
"ContentDisposition":{
"shape":"ContentDisposition",
"documentation":"Specifies presentational information for the object.",
"documentation":"<p>Specifies presentational information for the object.</p>",
"location":"header",
"locationName":"Content-Disposition"
},
"ContentEncoding":{
"shape":"ContentEncoding",
"documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.",
"documentation":"<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location":"header",
"locationName":"Content-Encoding"
},
"ContentLanguage":{
"shape":"ContentLanguage",
"documentation":"The language the content is in.",
"documentation":"<p>The language the content is in.</p>",
"location":"header",
"locationName":"Content-Language"
},
"ContentRange":{
"shape":"ContentRange",
"documentation":"The portion of the object returned in the response.",
"documentation":"<p>The portion of the object returned in the response.</p>",
"location":"header",
"locationName":"Content-Range"
},
"ContentType":{
"shape":"ContentType",
"documentation":"A standard MIME type describing the format of the object data.",
"documentation":"<p>A standard MIME type describing the format of the object data.</p>",
"location":"header",
"locationName":"Content-Type"
},
"Expires":{
"shape":"Expires",
"documentation":"The date and time at which the object is no longer cacheable.",
"documentation":"<p>The date and time at which the object is no longer cacheable.</p>",
"location":"header",
"locationName":"Expires"
},
"WebsiteRedirectLocation":{
"shape":"WebsiteRedirectLocation",
"documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.",
"documentation":"<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location":"header",
"locationName":"x-amz-website-redirect-location"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"Metadata":{
"shape":"Metadata",
"documentation":"A map of metadata to store with the object in S3.",
"documentation":"<p>A map of metadata to store with the object in S3.</p>",
"location":"headers",
"locationName":"x-amz-meta-"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -3128,13 +3129,13 @@
},
"PartsCount":{
"shape":"PartsCount",
"documentation":"The count of parts this object has.",
"documentation":"<p>The count of parts this object has.</p>",
"location":"header",
"locationName":"x-amz-mp-parts-count"
},
"TagCount":{
"shape":"TagCount",
"documentation":"The number of tags, if any, on the object.",
"documentation":"<p>The number of tags, if any, on the object.</p>",
"location":"header",
"locationName":"x-amz-tagging-count"
}
@ -3155,25 +3156,25 @@
},
"IfMatch":{
"shape":"IfMatch",
"documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).",
"documentation":"<p>Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).</p>",
"location":"header",
"locationName":"If-Match"
},
"IfModifiedSince":{
"shape":"IfModifiedSince",
"documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).",
"documentation":"<p>Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).</p>",
"location":"header",
"locationName":"If-Modified-Since"
},
"IfNoneMatch":{
"shape":"IfNoneMatch",
"documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).",
"documentation":"<p>Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).</p>",
"location":"header",
"locationName":"If-None-Match"
},
"IfUnmodifiedSince":{
"shape":"IfUnmodifiedSince",
"documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).",
"documentation":"<p>Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).</p>",
"location":"header",
"locationName":"If-Unmodified-Since"
},
@ -3184,67 +3185,67 @@
},
"Range":{
"shape":"Range",
"documentation":"Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.",
"documentation":"<p>Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.</p>",
"location":"header",
"locationName":"Range"
},
"ResponseCacheControl":{
"shape":"ResponseCacheControl",
"documentation":"Sets the Cache-Control header of the response.",
"documentation":"<p>Sets the Cache-Control header of the response.</p>",
"location":"querystring",
"locationName":"response-cache-control"
},
"ResponseContentDisposition":{
"shape":"ResponseContentDisposition",
"documentation":"Sets the Content-Disposition header of the response",
"documentation":"<p>Sets the Content-Disposition header of the response</p>",
"location":"querystring",
"locationName":"response-content-disposition"
},
"ResponseContentEncoding":{
"shape":"ResponseContentEncoding",
"documentation":"Sets the Content-Encoding header of the response.",
"documentation":"<p>Sets the Content-Encoding header of the response.</p>",
"location":"querystring",
"locationName":"response-content-encoding"
},
"ResponseContentLanguage":{
"shape":"ResponseContentLanguage",
"documentation":"Sets the Content-Language header of the response.",
"documentation":"<p>Sets the Content-Language header of the response.</p>",
"location":"querystring",
"locationName":"response-content-language"
},
"ResponseContentType":{
"shape":"ResponseContentType",
"documentation":"Sets the Content-Type header of the response.",
"documentation":"<p>Sets the Content-Type header of the response.</p>",
"location":"querystring",
"locationName":"response-content-type"
},
"ResponseExpires":{
"shape":"ResponseExpires",
"documentation":"Sets the Expires header of the response.",
"documentation":"<p>Sets the Expires header of the response.</p>",
"location":"querystring",
"locationName":"response-expires"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"VersionId used to reference a specific version of the object.",
"documentation":"<p>VersionId used to reference a specific version of the object.</p>",
"location":"querystring",
"locationName":"versionId"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
@ -3255,7 +3256,7 @@
},
"PartNumber":{
"shape":"PartNumber",
"documentation":"Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.",
"documentation":"<p>Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.</p>",
"location":"querystring",
"locationName":"partNumber"
}
@ -3342,7 +3343,7 @@
"members":{
"Tier":{
"shape":"Tier",
"documentation":"Glacier retrieval tier at which the restore will be processed."
"documentation":"<p>Glacier retrieval tier at which the restore will be processed.</p>"
}
}
},
@ -3352,7 +3353,7 @@
"Grantee":{"shape":"Grantee"},
"Permission":{
"shape":"Permission",
"documentation":"Specifies the permission given to the grantee."
"documentation":"<p>Specifies the permission given to the grantee.</p>"
}
}
},
@ -3367,25 +3368,25 @@
"members":{
"DisplayName":{
"shape":"DisplayName",
"documentation":"Screen name of the grantee."
"documentation":"<p>Screen name of the grantee.</p>"
},
"EmailAddress":{
"shape":"EmailAddress",
"documentation":"Email address of the grantee."
"documentation":"<p>Email address of the grantee.</p>"
},
"ID":{
"shape":"ID",
"documentation":"The canonical user ID of the grantee."
"documentation":"<p>The canonical user ID of the grantee.</p>"
},
"Type":{
"shape":"Type",
"documentation":"Type of grantee",
"documentation":"<p>Type of grantee</p>",
"locationName":"xsi:type",
"xmlAttribute":true
},
"URI":{
"shape":"URI",
"documentation":"URI of the grantee group."
"documentation":"<p>URI of the grantee group.</p>"
}
},
"xmlNamespace":{
@ -3416,7 +3417,7 @@
"members":{
"DeleteMarker":{
"shape":"DeleteMarker",
"documentation":"Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.",
"documentation":"<p>Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.</p>",
"location":"header",
"locationName":"x-amz-delete-marker"
},
@ -3427,115 +3428,115 @@
},
"Expiration":{
"shape":"Expiration",
"documentation":"If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.",
"documentation":"<p>If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
"Restore":{
"shape":"Restore",
"documentation":"Provides information about object restoration operation and expiration time of the restored object copy.",
"documentation":"<p>Provides information about object restoration operation and expiration time of the restored object copy.</p>",
"location":"header",
"locationName":"x-amz-restore"
},
"LastModified":{
"shape":"LastModified",
"documentation":"Last modified date of the object",
"documentation":"<p>Last modified date of the object</p>",
"location":"header",
"locationName":"Last-Modified"
},
"ContentLength":{
"shape":"ContentLength",
"documentation":"Size of the body in bytes.",
"documentation":"<p>Size of the body in bytes.</p>",
"location":"header",
"locationName":"Content-Length"
},
"ETag":{
"shape":"ETag",
"documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL",
"documentation":"<p>An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL</p>",
"location":"header",
"locationName":"ETag"
},
"MissingMeta":{
"shape":"MissingMeta",
"documentation":"This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.",
"documentation":"<p>This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.</p>",
"location":"header",
"locationName":"x-amz-missing-meta"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Version of the object.",
"documentation":"<p>Version of the object.</p>",
"location":"header",
"locationName":"x-amz-version-id"
},
"CacheControl":{
"shape":"CacheControl",
"documentation":"Specifies caching behavior along the request/reply chain.",
"documentation":"<p>Specifies caching behavior along the request/reply chain.</p>",
"location":"header",
"locationName":"Cache-Control"
},
"ContentDisposition":{
"shape":"ContentDisposition",
"documentation":"Specifies presentational information for the object.",
"documentation":"<p>Specifies presentational information for the object.</p>",
"location":"header",
"locationName":"Content-Disposition"
},
"ContentEncoding":{
"shape":"ContentEncoding",
"documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.",
"documentation":"<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location":"header",
"locationName":"Content-Encoding"
},
"ContentLanguage":{
"shape":"ContentLanguage",
"documentation":"The language the content is in.",
"documentation":"<p>The language the content is in.</p>",
"location":"header",
"locationName":"Content-Language"
},
"ContentType":{
"shape":"ContentType",
"documentation":"A standard MIME type describing the format of the object data.",
"documentation":"<p>A standard MIME type describing the format of the object data.</p>",
"location":"header",
"locationName":"Content-Type"
},
"Expires":{
"shape":"Expires",
"documentation":"The date and time at which the object is no longer cacheable.",
"documentation":"<p>The date and time at which the object is no longer cacheable.</p>",
"location":"header",
"locationName":"Expires"
},
"WebsiteRedirectLocation":{
"shape":"WebsiteRedirectLocation",
"documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.",
"documentation":"<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location":"header",
"locationName":"x-amz-website-redirect-location"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"Metadata":{
"shape":"Metadata",
"documentation":"A map of metadata to store with the object in S3.",
"documentation":"<p>A map of metadata to store with the object in S3.</p>",
"location":"headers",
"locationName":"x-amz-meta-"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -3556,7 +3557,7 @@
},
"PartsCount":{
"shape":"PartsCount",
"documentation":"The count of parts this object has.",
"documentation":"<p>The count of parts this object has.</p>",
"location":"header",
"locationName":"x-amz-mp-parts-count"
}
@ -3576,25 +3577,25 @@
},
"IfMatch":{
"shape":"IfMatch",
"documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).",
"documentation":"<p>Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).</p>",
"location":"header",
"locationName":"If-Match"
},
"IfModifiedSince":{
"shape":"IfModifiedSince",
"documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).",
"documentation":"<p>Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).</p>",
"location":"header",
"locationName":"If-Modified-Since"
},
"IfNoneMatch":{
"shape":"IfNoneMatch",
"documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).",
"documentation":"<p>Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).</p>",
"location":"header",
"locationName":"If-None-Match"
},
"IfUnmodifiedSince":{
"shape":"IfUnmodifiedSince",
"documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).",
"documentation":"<p>Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).</p>",
"location":"header",
"locationName":"If-Unmodified-Since"
},
@ -3605,31 +3606,31 @@
},
"Range":{
"shape":"Range",
"documentation":"Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.",
"documentation":"<p>Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.</p>",
"location":"header",
"locationName":"Range"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"VersionId used to reference a specific version of the object.",
"documentation":"<p>VersionId used to reference a specific version of the object.</p>",
"location":"querystring",
"locationName":"versionId"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
@ -3640,7 +3641,7 @@
},
"PartNumber":{
"shape":"PartNumber",
"documentation":"Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.",
"documentation":"<p>Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.</p>",
"location":"querystring",
"locationName":"partNumber"
}
@ -3660,7 +3661,7 @@
"members":{
"Suffix":{
"shape":"Suffix",
"documentation":"A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character."
"documentation":"<p>A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.</p>"
}
}
},
@ -3670,11 +3671,11 @@
"members":{
"ID":{
"shape":"ID",
"documentation":"If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value."
"documentation":"<p>If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.</p>"
},
"DisplayName":{
"shape":"DisplayName",
"documentation":"Name of the Principal."
"documentation":"<p>Name of the Principal.</p>"
}
}
},
@ -3683,18 +3684,18 @@
"members":{
"CSV":{
"shape":"CSVInput",
"documentation":"Describes the serialization of a CSV-encoded object."
"documentation":"<p>Describes the serialization of a CSV-encoded object.</p>"
},
"CompressionType":{
"shape":"CompressionType",
"documentation":"Specifies object's compression format. Valid values: NONE, GZIP. Default Value: NONE."
"documentation":"<p>Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.</p>"
},
"JSON":{
"shape":"JSONInput",
"documentation":"Specifies JSON as object's input serialization format."
"documentation":"<p>Specifies JSON as object's input serialization format.</p>"
}
},
"documentation":"Describes the serialization format of the object."
"documentation":"<p>Describes the serialization format of the object.</p>"
},
"InventoryConfiguration":{
"type":"structure",
@ -3708,31 +3709,31 @@
"members":{
"Destination":{
"shape":"InventoryDestination",
"documentation":"Contains information about where to publish the inventory results."
"documentation":"<p>Contains information about where to publish the inventory results.</p>"
},
"IsEnabled":{
"shape":"IsEnabled",
"documentation":"Specifies whether the inventory is enabled or disabled."
"documentation":"<p>Specifies whether the inventory is enabled or disabled.</p>"
},
"Filter":{
"shape":"InventoryFilter",
"documentation":"Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria."
"documentation":"<p>Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.</p>"
},
"Id":{
"shape":"InventoryId",
"documentation":"The ID used to identify the inventory configuration."
"documentation":"<p>The ID used to identify the inventory configuration.</p>"
},
"IncludedObjectVersions":{
"shape":"InventoryIncludedObjectVersions",
"documentation":"Specifies which object version(s) to included in the inventory results."
"documentation":"<p>Specifies which object version(s) to included in the inventory results.</p>"
},
"OptionalFields":{
"shape":"InventoryOptionalFields",
"documentation":"Contains the optional fields that are included in the inventory results."
"documentation":"<p>Contains the optional fields that are included in the inventory results.</p>"
},
"Schedule":{
"shape":"InventorySchedule",
"documentation":"Specifies the schedule for generating inventory results."
"documentation":"<p>Specifies the schedule for generating inventory results.</p>"
}
}
},
@ -3747,7 +3748,7 @@
"members":{
"S3BucketDestination":{
"shape":"InventoryS3BucketDestination",
"documentation":"Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published."
"documentation":"<p>Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.</p>"
}
}
},
@ -3756,16 +3757,16 @@
"members":{
"SSES3":{
"shape":"SSES3",
"documentation":"Specifies the use of SSE-S3 to encrypt delievered Inventory reports.",
"documentation":"<p>Specifies the use of SSE-S3 to encrypt delievered Inventory reports.</p>",
"locationName":"SSE-S3"
},
"SSEKMS":{
"shape":"SSEKMS",
"documentation":"Specifies the use of SSE-KMS to encrypt delievered Inventory reports.",
"documentation":"<p>Specifies the use of SSE-KMS to encrypt delievered Inventory reports.</p>",
"locationName":"SSE-KMS"
}
},
"documentation":"Contains the type of server-side encryption used to encrypt the inventory results."
"documentation":"<p>Contains the type of server-side encryption used to encrypt the inventory results.</p>"
},
"InventoryFilter":{
"type":"structure",
@ -3773,7 +3774,7 @@
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"The prefix that an object must have to be included in the inventory results."
"documentation":"<p>The prefix that an object must have to be included in the inventory results.</p>"
}
}
},
@ -3827,23 +3828,23 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"The ID of the account that owns the destination bucket."
"documentation":"<p>The ID of the account that owns the destination bucket.</p>"
},
"Bucket":{
"shape":"BucketName",
"documentation":"The Amazon resource name (ARN) of the bucket where inventory results will be published."
"documentation":"<p>The Amazon resource name (ARN) of the bucket where inventory results will be published.</p>"
},
"Format":{
"shape":"InventoryFormat",
"documentation":"Specifies the output format of the inventory results."
"documentation":"<p>Specifies the output format of the inventory results.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"The prefix that is prepended to all inventory results."
"documentation":"<p>The prefix that is prepended to all inventory results.</p>"
},
"Encryption":{
"shape":"InventoryEncryption",
"documentation":"Contains the type of server-side encryption used to encrypt the inventory results."
"documentation":"<p>Contains the type of server-side encryption used to encrypt the inventory results.</p>"
}
}
},
@ -3853,7 +3854,7 @@
"members":{
"Frequency":{
"shape":"InventoryFrequency",
"documentation":"Specifies how frequently inventory results are produced."
"documentation":"<p>Specifies how frequently inventory results are produced.</p>"
}
}
},
@ -3865,7 +3866,7 @@
"members":{
"Type":{
"shape":"JSONType",
"documentation":"The type of JSON. Valid values: Document, Lines."
"documentation":"<p>The type of JSON. Valid values: Document, Lines.</p>"
}
}
},
@ -3874,7 +3875,7 @@
"members":{
"RecordDelimiter":{
"shape":"RecordDelimiter",
"documentation":"The value used to separate individual records in the output."
"documentation":"<p>The value used to separate individual records in the output.</p>"
}
}
},
@ -3900,7 +3901,7 @@
"Id":{"shape":"NotificationId"},
"LambdaFunctionArn":{
"shape":"LambdaFunctionArn",
"documentation":"Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.",
"documentation":"<p>Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.</p>",
"locationName":"CloudFunction"
},
"Events":{
@ -3909,7 +3910,7 @@
},
"Filter":{"shape":"NotificationConfigurationFilter"}
},
"documentation":"Container for specifying the AWS Lambda notification configuration."
"documentation":"<p>Container for specifying the AWS Lambda notification configuration.</p>"
},
"LambdaFunctionConfigurationList":{
"type":"list",
@ -3932,15 +3933,15 @@
"members":{
"Date":{
"shape":"Date",
"documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format."
"documentation":"<p>Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.</p>"
},
"Days":{
"shape":"Days",
"documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer."
"documentation":"<p>Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.</p>"
},
"ExpiredObjectDeleteMarker":{
"shape":"ExpiredObjectDeleteMarker",
"documentation":"Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy."
"documentation":"<p>Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.</p>"
}
}
},
@ -3951,17 +3952,17 @@
"Expiration":{"shape":"LifecycleExpiration"},
"ID":{
"shape":"ID",
"documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters."
"documentation":"<p>Unique identifier for the rule. The value cannot be longer than 255 characters.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Prefix identifying one or more objects to which the rule applies. This is deprecated; use Filter instead.",
"documentation":"<p>Prefix identifying one or more objects to which the rule applies. This is deprecated; use Filter instead.</p>",
"deprecated":true
},
"Filter":{"shape":"LifecycleRuleFilter"},
"Status":{
"shape":"ExpirationStatus",
"documentation":"If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied."
"documentation":"<p>If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.</p>"
},
"Transitions":{
"shape":"TransitionList",
@ -3981,27 +3982,27 @@
"Prefix":{"shape":"Prefix"},
"Tags":{
"shape":"TagSet",
"documentation":"All of these tags must exist in the object's tag set in order for the rule to apply.",
"documentation":"<p>All of these tags must exist in the object's tag set in order for the rule to apply.</p>",
"flattened":true,
"locationName":"Tag"
}
},
"documentation":"This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator."
"documentation":"<p>This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.</p>"
},
"LifecycleRuleFilter":{
"type":"structure",
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"Prefix identifying one or more objects to which the rule applies."
"documentation":"<p>Prefix identifying one or more objects to which the rule applies.</p>"
},
"Tag":{
"shape":"Tag",
"documentation":"This tag must exist in the object's tag set in order for the rule to apply."
"documentation":"<p>This tag must exist in the object's tag set in order for the rule to apply.</p>"
},
"And":{"shape":"LifecycleRuleAndOperator"}
},
"documentation":"The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified."
"documentation":"<p>The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.</p>"
},
"LifecycleRules":{
"type":"list",
@ -4013,19 +4014,19 @@
"members":{
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request."
"documentation":"<p>Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.</p>"
},
"ContinuationToken":{
"shape":"Token",
"documentation":"The ContinuationToken that represents where this request began."
"documentation":"<p>The ContinuationToken that represents where this request began.</p>"
},
"NextContinuationToken":{
"shape":"NextToken",
"documentation":"NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value."
"documentation":"<p>NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.</p>"
},
"AnalyticsConfigurationList":{
"shape":"AnalyticsConfigurationList",
"documentation":"The list of analytics configurations for a bucket.",
"documentation":"<p>The list of analytics configurations for a bucket.</p>",
"locationName":"AnalyticsConfiguration"
}
}
@ -4036,13 +4037,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket from which analytics configurations are retrieved.",
"documentation":"<p>The name of the bucket from which analytics configurations are retrieved.</p>",
"location":"uri",
"locationName":"Bucket"
},
"ContinuationToken":{
"shape":"Token",
"documentation":"The ContinuationToken that represents a placeholder from where this request should begin.",
"documentation":"<p>The ContinuationToken that represents a placeholder from where this request should begin.</p>",
"location":"querystring",
"locationName":"continuation-token"
}
@ -4053,20 +4054,20 @@
"members":{
"ContinuationToken":{
"shape":"Token",
"documentation":"If sent in the request, the marker that is used as a starting point for this inventory configuration list response."
"documentation":"<p>If sent in the request, the marker that is used as a starting point for this inventory configuration list response.</p>"
},
"InventoryConfigurationList":{
"shape":"InventoryConfigurationList",
"documentation":"The list of inventory configurations for a bucket.",
"documentation":"<p>The list of inventory configurations for a bucket.</p>",
"locationName":"InventoryConfiguration"
},
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated."
"documentation":"<p>Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated.</p>"
},
"NextContinuationToken":{
"shape":"NextToken",
"documentation":"The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands."
"documentation":"<p>The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.</p>"
}
}
},
@ -4076,13 +4077,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket containing the inventory configurations to retrieve.",
"documentation":"<p>The name of the bucket containing the inventory configurations to retrieve.</p>",
"location":"uri",
"locationName":"Bucket"
},
"ContinuationToken":{
"shape":"Token",
"documentation":"The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.",
"documentation":"<p>The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.</p>",
"location":"querystring",
"locationName":"continuation-token"
}
@ -4093,19 +4094,19 @@
"members":{
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request."
"documentation":"<p>Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.</p>"
},
"ContinuationToken":{
"shape":"Token",
"documentation":"The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request."
"documentation":"<p>The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.</p>"
},
"NextContinuationToken":{
"shape":"NextToken",
"documentation":"The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands."
"documentation":"<p>The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.</p>"
},
"MetricsConfigurationList":{
"shape":"MetricsConfigurationList",
"documentation":"The list of metrics configurations for a bucket.",
"documentation":"<p>The list of metrics configurations for a bucket.</p>",
"locationName":"MetricsConfiguration"
}
}
@ -4116,13 +4117,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket containing the metrics configurations to retrieve.",
"documentation":"<p>The name of the bucket containing the metrics configurations to retrieve.</p>",
"location":"uri",
"locationName":"Bucket"
},
"ContinuationToken":{
"shape":"Token",
"documentation":"The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.",
"documentation":"<p>The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.</p>",
"location":"querystring",
"locationName":"continuation-token"
}
@ -4140,36 +4141,36 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket to which the multipart upload was initiated."
"documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p>"
},
"KeyMarker":{
"shape":"KeyMarker",
"documentation":"The key at or after which the listing began."
"documentation":"<p>The key at or after which the listing began.</p>"
},
"UploadIdMarker":{
"shape":"UploadIdMarker",
"documentation":"Upload ID after which listing began."
"documentation":"<p>Upload ID after which listing began.</p>"
},
"NextKeyMarker":{
"shape":"NextKeyMarker",
"documentation":"When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request."
"documentation":"<p>When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix."
"documentation":"<p>When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.</p>"
},
"Delimiter":{"shape":"Delimiter"},
"NextUploadIdMarker":{
"shape":"NextUploadIdMarker",
"documentation":"When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request."
"documentation":"<p>When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.</p>"
},
"MaxUploads":{
"shape":"MaxUploads",
"documentation":"Maximum number of multipart uploads that could have been included in the response."
"documentation":"<p>Maximum number of multipart uploads that could have been included in the response.</p>"
},
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads."
"documentation":"<p>Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.</p>"
},
"Uploads":{
"shape":"MultipartUploadList",
@ -4178,7 +4179,7 @@
"CommonPrefixes":{"shape":"CommonPrefixList"},
"EncodingType":{
"shape":"EncodingType",
"documentation":"Encoding type used by Amazon S3 to encode object keys in the response."
"documentation":"<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>"
}
}
},
@ -4193,7 +4194,7 @@
},
"Delimiter":{
"shape":"Delimiter",
"documentation":"Character you use to group keys.",
"documentation":"<p>Character you use to group keys.</p>",
"location":"querystring",
"locationName":"delimiter"
},
@ -4204,25 +4205,25 @@
},
"KeyMarker":{
"shape":"KeyMarker",
"documentation":"Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.",
"documentation":"<p>Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.</p>",
"location":"querystring",
"locationName":"key-marker"
},
"MaxUploads":{
"shape":"MaxUploads",
"documentation":"Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.",
"documentation":"<p>Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.</p>",
"location":"querystring",
"locationName":"max-uploads"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Lists in-progress uploads only for those keys that begin with the specified prefix.",
"documentation":"<p>Lists in-progress uploads only for those keys that begin with the specified prefix.</p>",
"location":"querystring",
"locationName":"prefix"
},
"UploadIdMarker":{
"shape":"UploadIdMarker",
"documentation":"Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.",
"documentation":"<p>Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.</p>",
"location":"querystring",
"locationName":"upload-id-marker"
}
@ -4233,20 +4234,20 @@
"members":{
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results."
"documentation":"<p>A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.</p>"
},
"KeyMarker":{
"shape":"KeyMarker",
"documentation":"Marks the last Key returned in a truncated response."
"documentation":"<p>Marks the last Key returned in a truncated response.</p>"
},
"VersionIdMarker":{"shape":"VersionIdMarker"},
"NextKeyMarker":{
"shape":"NextKeyMarker",
"documentation":"Use this value for the key marker request parameter in a subsequent request."
"documentation":"<p>Use this value for the key marker request parameter in a subsequent request.</p>"
},
"NextVersionIdMarker":{
"shape":"NextVersionIdMarker",
"documentation":"Use this value for the next version id marker parameter in a subsequent request."
"documentation":"<p>Use this value for the next version id marker parameter in a subsequent request.</p>"
},
"Versions":{
"shape":"ObjectVersionList",
@ -4263,7 +4264,7 @@
"CommonPrefixes":{"shape":"CommonPrefixList"},
"EncodingType":{
"shape":"EncodingType",
"documentation":"Encoding type used by Amazon S3 to encode object keys in the response."
"documentation":"<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>"
}
}
},
@ -4278,7 +4279,7 @@
},
"Delimiter":{
"shape":"Delimiter",
"documentation":"A delimiter is a character you use to group keys.",
"documentation":"<p>A delimiter is a character you use to group keys.</p>",
"location":"querystring",
"locationName":"delimiter"
},
@ -4289,25 +4290,25 @@
},
"KeyMarker":{
"shape":"KeyMarker",
"documentation":"Specifies the key to start with when listing objects in a bucket.",
"documentation":"<p>Specifies the key to start with when listing objects in a bucket.</p>",
"location":"querystring",
"locationName":"key-marker"
},
"MaxKeys":{
"shape":"MaxKeys",
"documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.",
"documentation":"<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>",
"location":"querystring",
"locationName":"max-keys"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Limits the response to keys that begin with the specified prefix.",
"documentation":"<p>Limits the response to keys that begin with the specified prefix.</p>",
"location":"querystring",
"locationName":"prefix"
},
"VersionIdMarker":{
"shape":"VersionIdMarker",
"documentation":"Specifies the object version you want to start listing from.",
"documentation":"<p>Specifies the object version you want to start listing from.</p>",
"location":"querystring",
"locationName":"version-id-marker"
}
@ -4318,12 +4319,12 @@
"members":{
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria."
"documentation":"<p>A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.</p>"
},
"Marker":{"shape":"Marker"},
"NextMarker":{
"shape":"NextMarker",
"documentation":"When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys."
"documentation":"<p>When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.</p>"
},
"Contents":{"shape":"ObjectList"},
"Name":{"shape":"BucketName"},
@ -4333,7 +4334,7 @@
"CommonPrefixes":{"shape":"CommonPrefixList"},
"EncodingType":{
"shape":"EncodingType",
"documentation":"Encoding type used by Amazon S3 to encode object keys in the response."
"documentation":"<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>"
}
}
},
@ -4348,7 +4349,7 @@
},
"Delimiter":{
"shape":"Delimiter",
"documentation":"A delimiter is a character you use to group keys.",
"documentation":"<p>A delimiter is a character you use to group keys.</p>",
"location":"querystring",
"locationName":"delimiter"
},
@ -4359,25 +4360,25 @@
},
"Marker":{
"shape":"Marker",
"documentation":"Specifies the key to start with when listing objects in a bucket.",
"documentation":"<p>Specifies the key to start with when listing objects in a bucket.</p>",
"location":"querystring",
"locationName":"marker"
},
"MaxKeys":{
"shape":"MaxKeys",
"documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.",
"documentation":"<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>",
"location":"querystring",
"locationName":"max-keys"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Limits the response to keys that begin with the specified prefix.",
"documentation":"<p>Limits the response to keys that begin with the specified prefix.</p>",
"location":"querystring",
"locationName":"prefix"
},
"RequestPayer":{
"shape":"RequestPayer",
"documentation":"Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.",
"documentation":"<p>Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.</p>",
"location":"header",
"locationName":"x-amz-request-payer"
}
@ -4388,51 +4389,51 @@
"members":{
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria."
"documentation":"<p>A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.</p>"
},
"Contents":{
"shape":"ObjectList",
"documentation":"Metadata about each object returned."
"documentation":"<p>Metadata about each object returned.</p>"
},
"Name":{
"shape":"BucketName",
"documentation":"Name of the bucket to list."
"documentation":"<p>Name of the bucket to list.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Limits the response to keys that begin with the specified prefix."
"documentation":"<p>Limits the response to keys that begin with the specified prefix.</p>"
},
"Delimiter":{
"shape":"Delimiter",
"documentation":"A delimiter is a character you use to group keys."
"documentation":"<p>A delimiter is a character you use to group keys.</p>"
},
"MaxKeys":{
"shape":"MaxKeys",
"documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more."
"documentation":"<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>"
},
"CommonPrefixes":{
"shape":"CommonPrefixList",
"documentation":"CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter"
"documentation":"<p>CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter</p>"
},
"EncodingType":{
"shape":"EncodingType",
"documentation":"Encoding type used by Amazon S3 to encode object keys in the response."
"documentation":"<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>"
},
"KeyCount":{
"shape":"KeyCount",
"documentation":"KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys"
"documentation":"<p>KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys </p>"
},
"ContinuationToken":{
"shape":"Token",
"documentation":"ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key"
"documentation":"<p>ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key</p>"
},
"NextContinuationToken":{
"shape":"NextToken",
"documentation":"NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key"
"documentation":"<p>NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key</p>"
},
"StartAfter":{
"shape":"StartAfter",
"documentation":"StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket"
"documentation":"<p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket</p>"
}
}
},
@ -4442,55 +4443,55 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket to list.",
"documentation":"<p>Name of the bucket to list.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Delimiter":{
"shape":"Delimiter",
"documentation":"A delimiter is a character you use to group keys.",
"documentation":"<p>A delimiter is a character you use to group keys.</p>",
"location":"querystring",
"locationName":"delimiter"
},
"EncodingType":{
"shape":"EncodingType",
"documentation":"Encoding type used by Amazon S3 to encode object keys in the response.",
"documentation":"<p>Encoding type used by Amazon S3 to encode object keys in the response.</p>",
"location":"querystring",
"locationName":"encoding-type"
},
"MaxKeys":{
"shape":"MaxKeys",
"documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.",
"documentation":"<p>Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.</p>",
"location":"querystring",
"locationName":"max-keys"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Limits the response to keys that begin with the specified prefix.",
"documentation":"<p>Limits the response to keys that begin with the specified prefix.</p>",
"location":"querystring",
"locationName":"prefix"
},
"ContinuationToken":{
"shape":"Token",
"documentation":"ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key",
"documentation":"<p>ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key</p>",
"location":"querystring",
"locationName":"continuation-token"
},
"FetchOwner":{
"shape":"FetchOwner",
"documentation":"The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true",
"documentation":"<p>The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true</p>",
"location":"querystring",
"locationName":"fetch-owner"
},
"StartAfter":{
"shape":"StartAfter",
"documentation":"StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket",
"documentation":"<p>StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket</p>",
"location":"querystring",
"locationName":"start-after"
},
"RequestPayer":{
"shape":"RequestPayer",
"documentation":"Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.",
"documentation":"<p>Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.</p>",
"location":"header",
"locationName":"x-amz-request-payer"
}
@ -4501,43 +4502,43 @@
"members":{
"AbortDate":{
"shape":"AbortDate",
"documentation":"Date when multipart upload will become eligible for abort operation by lifecycle.",
"documentation":"<p>Date when multipart upload will become eligible for abort operation by lifecycle.</p>",
"location":"header",
"locationName":"x-amz-abort-date"
},
"AbortRuleId":{
"shape":"AbortRuleId",
"documentation":"Id of the lifecycle rule that makes a multipart upload eligible for abort operation.",
"documentation":"<p>Id of the lifecycle rule that makes a multipart upload eligible for abort operation.</p>",
"location":"header",
"locationName":"x-amz-abort-rule-id"
},
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket to which the multipart upload was initiated."
"documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p>"
},
"Key":{
"shape":"ObjectKey",
"documentation":"Object key for which the multipart upload was initiated."
"documentation":"<p>Object key for which the multipart upload was initiated.</p>"
},
"UploadId":{
"shape":"MultipartUploadId",
"documentation":"Upload ID identifying the multipart upload whose parts are being listed."
"documentation":"<p>Upload ID identifying the multipart upload whose parts are being listed.</p>"
},
"PartNumberMarker":{
"shape":"PartNumberMarker",
"documentation":"Part number after which listing begins."
"documentation":"<p>Part number after which listing begins.</p>"
},
"NextPartNumberMarker":{
"shape":"NextPartNumberMarker",
"documentation":"When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request."
"documentation":"<p>When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.</p>"
},
"MaxParts":{
"shape":"MaxParts",
"documentation":"Maximum number of parts that were allowed in the response."
"documentation":"<p>Maximum number of parts that were allowed in the response.</p>"
},
"IsTruncated":{
"shape":"IsTruncated",
"documentation":"Indicates whether the returned list of parts is truncated."
"documentation":"<p>Indicates whether the returned list of parts is truncated.</p>"
},
"Parts":{
"shape":"Parts",
@ -4545,12 +4546,12 @@
},
"Initiator":{
"shape":"Initiator",
"documentation":"Identifies who initiated the multipart upload."
"documentation":"<p>Identifies who initiated the multipart upload.</p>"
},
"Owner":{"shape":"Owner"},
"StorageClass":{
"shape":"StorageClass",
"documentation":"The class of storage used to store the object."
"documentation":"<p>The class of storage used to store the object.</p>"
},
"RequestCharged":{
"shape":"RequestCharged",
@ -4579,19 +4580,19 @@
},
"MaxParts":{
"shape":"MaxParts",
"documentation":"Sets the maximum number of parts to return.",
"documentation":"<p>Sets the maximum number of parts to return.</p>",
"location":"querystring",
"locationName":"max-parts"
},
"PartNumberMarker":{
"shape":"PartNumberMarker",
"documentation":"Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.",
"documentation":"<p>Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.</p>",
"location":"querystring",
"locationName":"part-number-marker"
},
"UploadId":{
"shape":"MultipartUploadId",
"documentation":"Upload ID identifying the multipart upload whose parts are being listed.",
"documentation":"<p>Upload ID identifying the multipart upload whose parts are being listed.</p>",
"location":"querystring",
"locationName":"uploadId"
},
@ -4613,15 +4614,15 @@
"members":{
"TargetBucket":{
"shape":"TargetBucket",
"documentation":"Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key."
"documentation":"<p>Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.</p>"
},
"TargetGrants":{"shape":"TargetGrants"},
"TargetPrefix":{
"shape":"TargetPrefix",
"documentation":"This element lets you specify a prefix for the keys that the log files will be stored under."
"documentation":"<p>This element lets you specify a prefix for the keys that the log files will be stored under.</p>"
}
},
"documentation":"Container for logging information. Presence of this element indicates that logging is enabled. Parameters TargetBucket and TargetPrefix are required in this case."
"documentation":"<p>Container for logging information. Presence of this element indicates that logging is enabled. Parameters TargetBucket and TargetPrefix are required in this case.</p>"
},
"MFA":{"type":"string"},
"MFADelete":{
@ -4662,7 +4663,7 @@
"Name":{"shape":"MetadataKey"},
"Value":{"shape":"MetadataValue"}
},
"documentation":"A metadata key-value pair to store with an object."
"documentation":"<p>A metadata key-value pair to store with an object.</p>"
},
"MetadataKey":{"type":"string"},
"MetadataValue":{"type":"string"},
@ -4671,11 +4672,11 @@
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"The prefix used when evaluating an AND predicate."
"documentation":"<p>The prefix used when evaluating an AND predicate.</p>"
},
"Tags":{
"shape":"TagSet",
"documentation":"The list of tags used when evaluating an AND predicate.",
"documentation":"<p>The list of tags used when evaluating an AND predicate.</p>",
"flattened":true,
"locationName":"Tag"
}
@ -4687,11 +4688,11 @@
"members":{
"Id":{
"shape":"MetricsId",
"documentation":"The ID used to identify the metrics configuration."
"documentation":"<p>The ID used to identify the metrics configuration.</p>"
},
"Filter":{
"shape":"MetricsFilter",
"documentation":"Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator)."
"documentation":"<p>Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).</p>"
}
}
},
@ -4705,15 +4706,15 @@
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"The prefix used when evaluating a metrics filter."
"documentation":"<p>The prefix used when evaluating a metrics filter.</p>"
},
"Tag":{
"shape":"Tag",
"documentation":"The tag used when evaluating a metrics filter."
"documentation":"<p>The tag used when evaluating a metrics filter.</p>"
},
"And":{
"shape":"MetricsAndOperator",
"documentation":"A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply."
"documentation":"<p>A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.</p>"
}
}
},
@ -4724,24 +4725,24 @@
"members":{
"UploadId":{
"shape":"MultipartUploadId",
"documentation":"Upload ID that identifies the multipart upload."
"documentation":"<p>Upload ID that identifies the multipart upload.</p>"
},
"Key":{
"shape":"ObjectKey",
"documentation":"Key of the object for which the multipart upload was initiated."
"documentation":"<p>Key of the object for which the multipart upload was initiated.</p>"
},
"Initiated":{
"shape":"Initiated",
"documentation":"Date and time at which the multipart upload was initiated."
"documentation":"<p>Date and time at which the multipart upload was initiated.</p>"
},
"StorageClass":{
"shape":"StorageClass",
"documentation":"The class of storage used to store the object."
"documentation":"<p>The class of storage used to store the object.</p>"
},
"Owner":{"shape":"Owner"},
"Initiator":{
"shape":"Initiator",
"documentation":"Identifies who initiated the multipart upload."
"documentation":"<p>Identifies who initiated the multipart upload.</p>"
}
}
},
@ -4761,21 +4762,21 @@
"type":"structure",
"members":{
},
"documentation":"The specified bucket does not exist.",
"documentation":"<p>The specified bucket does not exist.</p>",
"exception":true
},
"NoSuchKey":{
"type":"structure",
"members":{
},
"documentation":"The specified key does not exist.",
"documentation":"<p>The specified key does not exist.</p>",
"exception":true
},
"NoSuchUpload":{
"type":"structure",
"members":{
},
"documentation":"The specified multipart upload does not exist.",
"documentation":"<p>The specified multipart upload does not exist.</p>",
"exception":true
},
"NoncurrentVersionExpiration":{
@ -4783,24 +4784,24 @@
"members":{
"NoncurrentDays":{
"shape":"Days",
"documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">How Amazon S3 Calculates When an Object Became Noncurrent</a> in the Amazon Simple Storage Service Developer Guide."
"documentation":"<p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">How Amazon S3 Calculates When an Object Became Noncurrent</a> in the Amazon Simple Storage Service Developer Guide.</p>"
}
},
"documentation":"Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime."
"documentation":"<p>Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.</p>"
},
"NoncurrentVersionTransition":{
"type":"structure",
"members":{
"NoncurrentDays":{
"shape":"Days",
"documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">How Amazon S3 Calculates When an Object Became Noncurrent</a> in the Amazon Simple Storage Service Developer Guide."
"documentation":"<p>Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">How Amazon S3 Calculates When an Object Became Noncurrent</a> in the Amazon Simple Storage Service Developer Guide.</p>"
},
"StorageClass":{
"shape":"TransitionStorageClass",
"documentation":"The class of storage used to store the object."
"documentation":"<p>The class of storage used to store the object.</p>"
}
},
"documentation":"Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA or GLACIER storage class at a specific period in the object's lifetime."
"documentation":"<p>Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA or GLACIER storage class at a specific period in the object's lifetime.</p>"
},
"NoncurrentVersionTransitionList":{
"type":"list",
@ -4823,7 +4824,7 @@
"locationName":"CloudFunctionConfiguration"
}
},
"documentation":"Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket."
"documentation":"<p>Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket.</p>"
},
"NotificationConfigurationDeprecated":{
"type":"structure",
@ -4841,11 +4842,11 @@
"locationName":"S3Key"
}
},
"documentation":"Container for object key name filtering rules. For information about key name filtering, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a> in the Amazon Simple Storage Service Developer Guide."
"documentation":"<p>Container for object key name filtering rules. For information about key name filtering, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html\">Configuring Event Notifications</a> in the Amazon Simple Storage Service Developer Guide.</p>"
},
"NotificationId":{
"type":"string",
"documentation":"Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID."
"documentation":"<p>Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.</p>"
},
"Object":{
"type":"structure",
@ -4856,7 +4857,7 @@
"Size":{"shape":"Size"},
"StorageClass":{
"shape":"ObjectStorageClass",
"documentation":"The class of storage used to store the object."
"documentation":"<p>The class of storage used to store the object.</p>"
},
"Owner":{"shape":"Owner"}
}
@ -4865,7 +4866,7 @@
"type":"structure",
"members":{
},
"documentation":"This operation is not allowed against this storage tier",
"documentation":"<p>This operation is not allowed against this storage tier</p>",
"exception":true
},
"ObjectCannedACL":{
@ -4886,11 +4887,11 @@
"members":{
"Key":{
"shape":"ObjectKey",
"documentation":"Key name of the object to delete."
"documentation":"<p>Key name of the object to delete.</p>"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"VersionId for the specific version of the object to delete."
"documentation":"<p>VersionId for the specific version of the object to delete.</p>"
}
}
},
@ -4912,7 +4913,7 @@
"type":"structure",
"members":{
},
"documentation":"The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.",
"documentation":"<p>The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.</p>",
"exception":true
},
"ObjectStorageClass":{
@ -4931,27 +4932,27 @@
"ETag":{"shape":"ETag"},
"Size":{
"shape":"Size",
"documentation":"Size in bytes of the object."
"documentation":"<p>Size in bytes of the object.</p>"
},
"StorageClass":{
"shape":"ObjectVersionStorageClass",
"documentation":"The class of storage used to store the object."
"documentation":"<p>The class of storage used to store the object.</p>"
},
"Key":{
"shape":"ObjectKey",
"documentation":"The object key."
"documentation":"<p>The object key.</p>"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Version ID of an object."
"documentation":"<p>Version ID of an object.</p>"
},
"IsLatest":{
"shape":"IsLatest",
"documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object."
"documentation":"<p>Specifies whether the object is (true) or is not (false) the latest version of an object.</p>"
},
"LastModified":{
"shape":"LastModified",
"documentation":"Date and time the object was last modified."
"documentation":"<p>Date and time the object was last modified.</p>"
},
"Owner":{"shape":"Owner"}
}
@ -4971,24 +4972,24 @@
"members":{
"S3":{
"shape":"S3Location",
"documentation":"Describes an S3 location that will receive the results of the restore request."
"documentation":"<p>Describes an S3 location that will receive the results of the restore request.</p>"
}
},
"documentation":"Describes the location where the restore job's output is stored."
"documentation":"<p>Describes the location where the restore job's output is stored.</p>"
},
"OutputSerialization":{
"type":"structure",
"members":{
"CSV":{
"shape":"CSVOutput",
"documentation":"Describes the serialization of CSV-encoded Select results."
"documentation":"<p>Describes the serialization of CSV-encoded Select results.</p>"
},
"JSON":{
"shape":"JSONOutput",
"documentation":"Specifies JSON as request's output serialization format."
"documentation":"<p>Specifies JSON as request's output serialization format.</p>"
}
},
"documentation":"Describes how results of the Select job are serialized."
"documentation":"<p>Describes how results of the Select job are serialized.</p>"
},
"Owner":{
"type":"structure",
@ -5006,19 +5007,19 @@
"members":{
"PartNumber":{
"shape":"PartNumber",
"documentation":"Part number identifying the part. This is a positive integer between 1 and 10,000."
"documentation":"<p>Part number identifying the part. This is a positive integer between 1 and 10,000.</p>"
},
"LastModified":{
"shape":"LastModified",
"documentation":"Date and time at which the part was uploaded."
"documentation":"<p>Date and time at which the part was uploaded.</p>"
},
"ETag":{
"shape":"ETag",
"documentation":"Entity tag returned when the part was uploaded."
"documentation":"<p>Entity tag returned when the part was uploaded.</p>"
},
"Size":{
"shape":"Size",
"documentation":"Size of the uploaded part data."
"documentation":"<p>Size of the uploaded part data.</p>"
}
}
},
@ -5054,15 +5055,15 @@
"members":{
"BytesScanned":{
"shape":"BytesScanned",
"documentation":"Current number of object bytes scanned."
"documentation":"<p>Current number of object bytes scanned.</p>"
},
"BytesProcessed":{
"shape":"BytesProcessed",
"documentation":"Current number of uncompressed object bytes processed."
"documentation":"<p>Current number of uncompressed object bytes processed.</p>"
},
"BytesReturned":{
"shape":"BytesReturned",
"documentation":"Current number of bytes of records payload data returned."
"documentation":"<p>Current number of bytes of records payload data returned.</p>"
}
}
},
@ -5071,7 +5072,7 @@
"members":{
"Details":{
"shape":"Progress",
"documentation":"The Progress event details.",
"documentation":"<p>The Progress event details.</p>",
"eventpayload":true
}
},
@ -5093,13 +5094,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket for which the accelerate configuration is set.",
"documentation":"<p>Name of the bucket for which the accelerate configuration is set.</p>",
"location":"uri",
"locationName":"Bucket"
},
"AccelerateConfiguration":{
"shape":"AccelerateConfiguration",
"documentation":"Specifies the Accelerate Configuration you want to set for the bucket.",
"documentation":"<p>Specifies the Accelerate Configuration you want to set for the bucket.</p>",
"locationName":"AccelerateConfiguration",
"xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}
}
@ -5112,7 +5113,7 @@
"members":{
"ACL":{
"shape":"BucketCannedACL",
"documentation":"The canned ACL to apply to the bucket.",
"documentation":"<p>The canned ACL to apply to the bucket.</p>",
"location":"header",
"locationName":"x-amz-acl"
},
@ -5133,31 +5134,31 @@
},
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.",
"documentation":"<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-full-control"
},
"GrantRead":{
"shape":"GrantRead",
"documentation":"Allows grantee to list the objects in the bucket.",
"documentation":"<p>Allows grantee to list the objects in the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-read"
},
"GrantReadACP":{
"shape":"GrantReadACP",
"documentation":"Allows grantee to read the bucket ACL.",
"documentation":"<p>Allows grantee to read the bucket ACL.</p>",
"location":"header",
"locationName":"x-amz-grant-read-acp"
},
"GrantWrite":{
"shape":"GrantWrite",
"documentation":"Allows grantee to create, overwrite, and delete any object in the bucket.",
"documentation":"<p>Allows grantee to create, overwrite, and delete any object in the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-write"
},
"GrantWriteACP":{
"shape":"GrantWriteACP",
"documentation":"Allows grantee to write the ACL for the applicable bucket.",
"documentation":"<p>Allows grantee to write the ACL for the applicable bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-write-acp"
}
@ -5174,19 +5175,19 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket to which an analytics configuration is stored.",
"documentation":"<p>The name of the bucket to which an analytics configuration is stored.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"AnalyticsId",
"documentation":"The identifier used to represent an analytics configuration.",
"documentation":"<p>The identifier used to represent an analytics configuration.</p>",
"location":"querystring",
"locationName":"id"
},
"AnalyticsConfiguration":{
"shape":"AnalyticsConfiguration",
"documentation":"The configuration and any analyses for the analytics filter.",
"documentation":"<p>The configuration and any analyses for the analytics filter.</p>",
"locationName":"AnalyticsConfiguration",
"xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}
}
@ -5227,13 +5228,13 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket for which the server-side encryption configuration is set.",
"documentation":"<p>The name of the bucket for which the server-side encryption configuration is set.</p>",
"location":"uri",
"locationName":"Bucket"
},
"ContentMD5":{
"shape":"ContentMD5",
"documentation":"The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.",
"documentation":"<p>The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.</p>",
"location":"header",
"locationName":"Content-MD5"
},
@ -5255,19 +5256,19 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket where the inventory configuration will be stored.",
"documentation":"<p>The name of the bucket where the inventory configuration will be stored.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"InventoryId",
"documentation":"The ID used to identify the inventory configuration.",
"documentation":"<p>The ID used to identify the inventory configuration.</p>",
"location":"querystring",
"locationName":"id"
},
"InventoryConfiguration":{
"shape":"InventoryConfiguration",
"documentation":"Specifies the inventory configuration.",
"documentation":"<p>Specifies the inventory configuration.</p>",
"locationName":"InventoryConfiguration",
"xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}
}
@ -5348,19 +5349,19 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The name of the bucket for which the metrics configuration is set.",
"documentation":"<p>The name of the bucket for which the metrics configuration is set.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Id":{
"shape":"MetricsId",
"documentation":"The ID used to identify the metrics configuration.",
"documentation":"<p>The ID used to identify the metrics configuration.</p>",
"location":"querystring",
"locationName":"id"
},
"MetricsConfiguration":{
"shape":"MetricsConfiguration",
"documentation":"Specifies the metrics configuration.",
"documentation":"<p>Specifies the metrics configuration.</p>",
"locationName":"MetricsConfiguration",
"xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"}
}
@ -5431,13 +5432,13 @@
},
"ConfirmRemoveSelfBucketAccess":{
"shape":"ConfirmRemoveSelfBucketAccess",
"documentation":"Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.",
"documentation":"<p>Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.</p>",
"location":"header",
"locationName":"x-amz-confirm-remove-self-bucket-access"
},
"Policy":{
"shape":"Policy",
"documentation":"The bucket policy as a JSON document."
"documentation":"<p>The bucket policy as a JSON document.</p>"
}
},
"payload":"Policy"
@ -5536,7 +5537,7 @@
},
"MFA":{
"shape":"MFA",
"documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.",
"documentation":"<p>The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.</p>",
"location":"header",
"locationName":"x-amz-mfa"
},
@ -5592,7 +5593,7 @@
"members":{
"ACL":{
"shape":"ObjectCannedACL",
"documentation":"The canned ACL to apply to the object.",
"documentation":"<p>The canned ACL to apply to the object.</p>",
"location":"header",
"locationName":"x-amz-acl"
},
@ -5613,31 +5614,31 @@
},
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.",
"documentation":"<p>Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-full-control"
},
"GrantRead":{
"shape":"GrantRead",
"documentation":"Allows grantee to list the objects in the bucket.",
"documentation":"<p>Allows grantee to list the objects in the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-read"
},
"GrantReadACP":{
"shape":"GrantReadACP",
"documentation":"Allows grantee to read the bucket ACL.",
"documentation":"<p>Allows grantee to read the bucket ACL.</p>",
"location":"header",
"locationName":"x-amz-grant-read-acp"
},
"GrantWrite":{
"shape":"GrantWrite",
"documentation":"Allows grantee to create, overwrite, and delete any object in the bucket.",
"documentation":"<p>Allows grantee to create, overwrite, and delete any object in the bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-write"
},
"GrantWriteACP":{
"shape":"GrantWriteACP",
"documentation":"Allows grantee to write the ACL for the applicable bucket.",
"documentation":"<p>Allows grantee to write the ACL for the applicable bucket.</p>",
"location":"header",
"locationName":"x-amz-grant-write-acp"
},
@ -5653,7 +5654,7 @@
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"VersionId used to reference a specific version of the object.",
"documentation":"<p>VersionId used to reference a specific version of the object.</p>",
"location":"querystring",
"locationName":"versionId"
}
@ -5665,43 +5666,43 @@
"members":{
"Expiration":{
"shape":"Expiration",
"documentation":"If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.",
"documentation":"<p>If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.</p>",
"location":"header",
"locationName":"x-amz-expiration"
},
"ETag":{
"shape":"ETag",
"documentation":"Entity tag for the uploaded object.",
"documentation":"<p>Entity tag for the uploaded object.</p>",
"location":"header",
"locationName":"ETag"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"VersionId":{
"shape":"ObjectVersionId",
"documentation":"Version of the object.",
"documentation":"<p>Version of the object.</p>",
"location":"header",
"locationName":"x-amz-version-id"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -5721,144 +5722,144 @@
"members":{
"ACL":{
"shape":"ObjectCannedACL",
"documentation":"The canned ACL to apply to the object.",
"documentation":"<p>The canned ACL to apply to the object.</p>",
"location":"header",
"locationName":"x-amz-acl"
},
"Body":{
"shape":"Body",
"documentation":"Object data.",
"documentation":"<p>Object data.</p>",
"streaming":true
},
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket to which the PUT operation was initiated.",
"documentation":"<p>Name of the bucket to which the PUT operation was initiated.</p>",
"location":"uri",
"locationName":"Bucket"
},
"CacheControl":{
"shape":"CacheControl",
"documentation":"Specifies caching behavior along the request/reply chain.",
"documentation":"<p>Specifies caching behavior along the request/reply chain.</p>",
"location":"header",
"locationName":"Cache-Control"
},
"ContentDisposition":{
"shape":"ContentDisposition",
"documentation":"Specifies presentational information for the object.",
"documentation":"<p>Specifies presentational information for the object.</p>",
"location":"header",
"locationName":"Content-Disposition"
},
"ContentEncoding":{
"shape":"ContentEncoding",
"documentation":"Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.",
"documentation":"<p>Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.</p>",
"location":"header",
"locationName":"Content-Encoding"
},
"ContentLanguage":{
"shape":"ContentLanguage",
"documentation":"The language the content is in.",
"documentation":"<p>The language the content is in.</p>",
"location":"header",
"locationName":"Content-Language"
},
"ContentLength":{
"shape":"ContentLength",
"documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.",
"documentation":"<p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.</p>",
"location":"header",
"locationName":"Content-Length"
},
"ContentMD5":{
"shape":"ContentMD5",
"documentation":"The base64-encoded 128-bit MD5 digest of the part data.",
"documentation":"<p>The base64-encoded 128-bit MD5 digest of the part data.</p>",
"location":"header",
"locationName":"Content-MD5"
},
"ContentType":{
"shape":"ContentType",
"documentation":"A standard MIME type describing the format of the object data.",
"documentation":"<p>A standard MIME type describing the format of the object data.</p>",
"location":"header",
"locationName":"Content-Type"
},
"Expires":{
"shape":"Expires",
"documentation":"The date and time at which the object is no longer cacheable.",
"documentation":"<p>The date and time at which the object is no longer cacheable.</p>",
"location":"header",
"locationName":"Expires"
},
"GrantFullControl":{
"shape":"GrantFullControl",
"documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.",
"documentation":"<p>Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.</p>",
"location":"header",
"locationName":"x-amz-grant-full-control"
},
"GrantRead":{
"shape":"GrantRead",
"documentation":"Allows grantee to read the object data and its metadata.",
"documentation":"<p>Allows grantee to read the object data and its metadata.</p>",
"location":"header",
"locationName":"x-amz-grant-read"
},
"GrantReadACP":{
"shape":"GrantReadACP",
"documentation":"Allows grantee to read the object ACL.",
"documentation":"<p>Allows grantee to read the object ACL.</p>",
"location":"header",
"locationName":"x-amz-grant-read-acp"
},
"GrantWriteACP":{
"shape":"GrantWriteACP",
"documentation":"Allows grantee to write the ACL for the applicable object.",
"documentation":"<p>Allows grantee to write the ACL for the applicable object.</p>",
"location":"header",
"locationName":"x-amz-grant-write-acp"
},
"Key":{
"shape":"ObjectKey",
"documentation":"Object key for which the PUT operation was initiated.",
"documentation":"<p>Object key for which the PUT operation was initiated.</p>",
"location":"uri",
"locationName":"Key"
},
"Metadata":{
"shape":"Metadata",
"documentation":"A map of metadata to store with the object in S3.",
"documentation":"<p>A map of metadata to store with the object in S3.</p>",
"location":"headers",
"locationName":"x-amz-meta-"
},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"StorageClass":{
"shape":"StorageClass",
"documentation":"The type of storage to use for the object. Defaults to 'STANDARD'.",
"documentation":"<p>The type of storage to use for the object. Defaults to 'STANDARD'.</p>",
"location":"header",
"locationName":"x-amz-storage-class"
},
"WebsiteRedirectLocation":{
"shape":"WebsiteRedirectLocation",
"documentation":"If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.",
"documentation":"<p>If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.</p>",
"location":"header",
"locationName":"x-amz-website-redirect-location"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version",
"documentation":"<p>Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -5869,7 +5870,7 @@
},
"Tagging":{
"shape":"TaggingHeader",
"documentation":"The tag-set for the object. The tag-set must be encoded as URL Query parameters",
"documentation":"<p>The tag-set for the object. The tag-set must be encoded as URL Query parameters</p>",
"location":"header",
"locationName":"x-amz-tagging"
}
@ -5933,7 +5934,7 @@
"Id":{"shape":"NotificationId"},
"QueueArn":{
"shape":"QueueArn",
"documentation":"Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.",
"documentation":"<p>Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.</p>",
"locationName":"Queue"
},
"Events":{
@ -5942,7 +5943,7 @@
},
"Filter":{"shape":"NotificationConfigurationFilter"}
},
"documentation":"Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue."
"documentation":"<p>Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue.</p>"
},
"QueueConfigurationDeprecated":{
"type":"structure",
@ -5981,7 +5982,7 @@
"members":{
"Payload":{
"shape":"Body",
"documentation":"The byte array of partial, one or more result records.",
"documentation":"<p>The byte array of partial, one or more result records.</p>",
"eventpayload":true
}
},
@ -5992,23 +5993,23 @@
"members":{
"HostName":{
"shape":"HostName",
"documentation":"The host name to use in the redirect request."
"documentation":"<p>The host name to use in the redirect request.</p>"
},
"HttpRedirectCode":{
"shape":"HttpRedirectCode",
"documentation":"The HTTP redirect code to use on the response. Not required if one of the siblings is present."
"documentation":"<p>The HTTP redirect code to use on the response. Not required if one of the siblings is present.</p>"
},
"Protocol":{
"shape":"Protocol",
"documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request."
"documentation":"<p>Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.</p>"
},
"ReplaceKeyPrefixWith":{
"shape":"ReplaceKeyPrefixWith",
"documentation":"The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided."
"documentation":"<p>The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.</p>"
},
"ReplaceKeyWith":{
"shape":"ReplaceKeyWith",
"documentation":"The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided."
"documentation":"<p>The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the sibling is present. Can be present only if ReplaceKeyPrefixWith is not provided.</p>"
}
}
},
@ -6018,11 +6019,11 @@
"members":{
"HostName":{
"shape":"HostName",
"documentation":"Name of the host where requests will be redirected."
"documentation":"<p>Name of the host where requests will be redirected.</p>"
},
"Protocol":{
"shape":"Protocol",
"documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request."
"documentation":"<p>Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request.</p>"
}
}
},
@ -6038,15 +6039,15 @@
"members":{
"Role":{
"shape":"Role",
"documentation":"Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects."
"documentation":"<p>Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects.</p>"
},
"Rules":{
"shape":"ReplicationRules",
"documentation":"Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.",
"documentation":"<p>Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.</p>",
"locationName":"Rule"
}
},
"documentation":"Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB."
"documentation":"<p>Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB.</p>"
},
"ReplicationRule":{
"type":"structure",
@ -6058,26 +6059,26 @@
"members":{
"ID":{
"shape":"ID",
"documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters."
"documentation":"<p>Unique identifier for the rule. The value cannot be longer than 255 characters.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported."
"documentation":"<p>Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported.</p>"
},
"Status":{
"shape":"ReplicationRuleStatus",
"documentation":"The rule is ignored if status is not Enabled."
"documentation":"<p>The rule is ignored if status is not Enabled.</p>"
},
"SourceSelectionCriteria":{
"shape":"SourceSelectionCriteria",
"documentation":"Container for filters that define which source objects should be replicated."
"documentation":"<p>Container for filters that define which source objects should be replicated.</p>"
},
"Destination":{
"shape":"Destination",
"documentation":"Container for replication destination information."
"documentation":"<p>Container for replication destination information.</p>"
}
},
"documentation":"Container for information about a particular replication rule."
"documentation":"<p>Container for information about a particular replication rule.</p>"
},
"ReplicationRuleStatus":{
"type":"string",
@ -6102,12 +6103,12 @@
},
"RequestCharged":{
"type":"string",
"documentation":"If present, indicates that the requester was successfully charged for the request.",
"documentation":"<p>If present, indicates that the requester was successfully charged for the request.</p>",
"enum":["requester"]
},
"RequestPayer":{
"type":"string",
"documentation":"Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html",
"documentation":"<p>Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html</p>",
"enum":["requester"]
},
"RequestPaymentConfiguration":{
@ -6116,7 +6117,7 @@
"members":{
"Payer":{
"shape":"Payer",
"documentation":"Specifies who pays for the download and request fees."
"documentation":"<p>Specifies who pays for the download and request fees.</p>"
}
}
},
@ -6125,7 +6126,7 @@
"members":{
"Enabled":{
"shape":"EnableRequestProgress",
"documentation":"Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE."
"documentation":"<p>Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.</p>"
}
}
},
@ -6146,7 +6147,7 @@
},
"RestoreOutputPath":{
"shape":"RestoreOutputPath",
"documentation":"Indicates the path in the provided S3 output location where Select results will be restored to.",
"documentation":"<p>Indicates the path in the provided S3 output location where Select results will be restored to.</p>",
"location":"header",
"locationName":"x-amz-restore-output-path"
}
@ -6193,34 +6194,34 @@
"members":{
"Days":{
"shape":"Days",
"documentation":"Lifetime of the active copy in days. Do not use with restores that specify OutputLocation."
"documentation":"<p>Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.</p>"
},
"GlacierJobParameters":{
"shape":"GlacierJobParameters",
"documentation":"Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation."
"documentation":"<p>Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.</p>"
},
"Type":{
"shape":"RestoreRequestType",
"documentation":"Type of restore request."
"documentation":"<p>Type of restore request.</p>"
},
"Tier":{
"shape":"Tier",
"documentation":"Glacier retrieval tier at which the restore will be processed."
"documentation":"<p>Glacier retrieval tier at which the restore will be processed.</p>"
},
"Description":{
"shape":"Description",
"documentation":"The optional description for the job."
"documentation":"<p>The optional description for the job.</p>"
},
"SelectParameters":{
"shape":"SelectParameters",
"documentation":"Describes the parameters for Select job types."
"documentation":"<p>Describes the parameters for Select job types.</p>"
},
"OutputLocation":{
"shape":"OutputLocation",
"documentation":"Describes the location where the restore job's output is stored."
"documentation":"<p>Describes the location where the restore job's output is stored.</p>"
}
},
"documentation":"Container for restore job parameters."
"documentation":"<p>Container for restore job parameters.</p>"
},
"RestoreRequestType":{
"type":"string",
@ -6233,11 +6234,11 @@
"members":{
"Condition":{
"shape":"Condition",
"documentation":"A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error."
"documentation":"<p>A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.</p>"
},
"Redirect":{
"shape":"Redirect",
"documentation":"Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return."
"documentation":"<p>Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.</p>"
}
}
},
@ -6258,15 +6259,15 @@
"Expiration":{"shape":"LifecycleExpiration"},
"ID":{
"shape":"ID",
"documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters."
"documentation":"<p>Unique identifier for the rule. The value cannot be longer than 255 characters.</p>"
},
"Prefix":{
"shape":"Prefix",
"documentation":"Prefix identifying one or more objects to which the rule applies."
"documentation":"<p>Prefix identifying one or more objects to which the rule applies.</p>"
},
"Status":{
"shape":"ExpirationStatus",
"documentation":"If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied."
"documentation":"<p>If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.</p>"
},
"Transition":{"shape":"Transition"},
"NoncurrentVersionTransition":{"shape":"NoncurrentVersionTransition"},
@ -6287,7 +6288,7 @@
"locationName":"FilterRule"
}
},
"documentation":"Container for object key name prefix and suffix filtering rules."
"documentation":"<p>Container for object key name prefix and suffix filtering rules.</p>"
},
"S3Location":{
"type":"structure",
@ -6298,35 +6299,35 @@
"members":{
"BucketName":{
"shape":"BucketName",
"documentation":"The name of the bucket where the restore results will be placed."
"documentation":"<p>The name of the bucket where the restore results will be placed.</p>"
},
"Prefix":{
"shape":"LocationPrefix",
"documentation":"The prefix that is prepended to the restore results for this request."
"documentation":"<p>The prefix that is prepended to the restore results for this request.</p>"
},
"Encryption":{"shape":"Encryption"},
"CannedACL":{
"shape":"ObjectCannedACL",
"documentation":"The canned ACL to apply to the restore results."
"documentation":"<p>The canned ACL to apply to the restore results.</p>"
},
"AccessControlList":{
"shape":"Grants",
"documentation":"A list of grants that control access to the staged results."
"documentation":"<p>A list of grants that control access to the staged results.</p>"
},
"Tagging":{
"shape":"Tagging",
"documentation":"The tag-set that is applied to the restore results."
"documentation":"<p>The tag-set that is applied to the restore results.</p>"
},
"UserMetadata":{
"shape":"UserMetadata",
"documentation":"A list of metadata to store with the restore results in S3."
"documentation":"<p>A list of metadata to store with the restore results in S3.</p>"
},
"StorageClass":{
"shape":"StorageClass",
"documentation":"The class of storage used to store the restore results."
"documentation":"<p>The class of storage used to store the restore results.</p>"
}
},
"documentation":"Describes an S3 location that will receive the results of the restore request."
"documentation":"<p>Describes an S3 location that will receive the results of the restore request.</p>"
},
"SSECustomerAlgorithm":{"type":"string"},
"SSECustomerKey":{
@ -6340,10 +6341,10 @@
"members":{
"KeyId":{
"shape":"SSEKMSKeyId",
"documentation":"Specifies the ID of the AWS Key Management Service (KMS) master encryption key to use for encrypting Inventory reports."
"documentation":"<p>Specifies the ID of the AWS Key Management Service (KMS) master encryption key to use for encrypting Inventory reports.</p>"
}
},
"documentation":"Specifies the use of SSE-KMS to encrypt delievered Inventory reports.",
"documentation":"<p>Specifies the use of SSE-KMS to encrypt delievered Inventory reports.</p>",
"locationName":"SSE-KMS"
},
"SSEKMSKeyId":{
@ -6354,7 +6355,7 @@
"type":"structure",
"members":{
},
"documentation":"Specifies the use of SSE-S3 to encrypt delievered Inventory reports.",
"documentation":"<p>Specifies the use of SSE-S3 to encrypt delievered Inventory reports.</p>",
"locationName":"SSE-S3"
},
"SelectObjectContentEventStream":{
@ -6362,23 +6363,23 @@
"members":{
"Records":{
"shape":"RecordsEvent",
"documentation":"The Records Event."
"documentation":"<p>The Records Event.</p>"
},
"Stats":{
"shape":"StatsEvent",
"documentation":"The Stats Event."
"documentation":"<p>The Stats Event.</p>"
},
"Progress":{
"shape":"ProgressEvent",
"documentation":"The Progress Event."
"documentation":"<p>The Progress Event.</p>"
},
"Cont":{
"shape":"ContinuationEvent",
"documentation":"The Continuation Event."
"documentation":"<p>The Continuation Event.</p>"
},
"End":{
"shape":"EndEvent",
"documentation":"The End Event."
"documentation":"<p>The End Event.</p>"
}
},
"eventstream":true
@ -6403,56 +6404,56 @@
"members":{
"Bucket":{
"shape":"BucketName",
"documentation":"The S3 Bucket.",
"documentation":"<p>The S3 Bucket.</p>",
"location":"uri",
"locationName":"Bucket"
},
"Key":{
"shape":"ObjectKey",
"documentation":"The Object Key.",
"documentation":"<p>The Object Key.</p>",
"location":"uri",
"locationName":"Key"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"The SSE Algorithm used to encrypt the object. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\"> Server-Side Encryption (Using Customer-Provided Encryption Keys</a>.",
"documentation":"<p>The SSE Algorithm used to encrypt the object. For more information, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\"> Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"The SSE Customer Key. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\"> Server-Side Encryption (Using Customer-Provided Encryption Keys</a>.",
"documentation":"<p>The SSE Customer Key. For more information, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\"> Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"The SSE Customer Key MD5. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\"> Server-Side Encryption (Using Customer-Provided Encryption Keys</a>.",
"documentation":"<p>The SSE Customer Key MD5. For more information, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html\"> Server-Side Encryption (Using Customer-Provided Encryption Keys</a>. </p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"Expression":{
"shape":"Expression",
"documentation":"The expression that is used to query the object."
"documentation":"<p>The expression that is used to query the object.</p>"
},
"ExpressionType":{
"shape":"ExpressionType",
"documentation":"The type of the provided expression (e.g., SQL)."
"documentation":"<p>The type of the provided expression (e.g., SQL).</p>"
},
"RequestProgress":{
"shape":"RequestProgress",
"documentation":"Specifies if periodic request progress information should be enabled."
"documentation":"<p>Specifies if periodic request progress information should be enabled.</p>"
},
"InputSerialization":{
"shape":"InputSerialization",
"documentation":"Describes the format of the data in the object that is being queried."
"documentation":"<p>Describes the format of the data in the object that is being queried.</p>"
},
"OutputSerialization":{
"shape":"OutputSerialization",
"documentation":"Describes the format of the data that you want Amazon S3 to return in response."
"documentation":"<p>Describes the format of the data that you want Amazon S3 to return in response.</p>"
}
},
"documentation":"Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, go to <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html\">S3Select API Documentation</a>."
"documentation":"<p>Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, go to <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html\">S3Select API Documentation</a>.</p>"
},
"SelectParameters":{
"type":"structure",
@ -6465,22 +6466,22 @@
"members":{
"InputSerialization":{
"shape":"InputSerialization",
"documentation":"Describes the serialization format of the object."
"documentation":"<p>Describes the serialization format of the object.</p>"
},
"ExpressionType":{
"shape":"ExpressionType",
"documentation":"The type of the provided expression (e.g., SQL)."
"documentation":"<p>The type of the provided expression (e.g., SQL).</p>"
},
"Expression":{
"shape":"Expression",
"documentation":"The expression that is used to query the object."
"documentation":"<p>The expression that is used to query the object.</p>"
},
"OutputSerialization":{
"shape":"OutputSerialization",
"documentation":"Describes how the results of the Select job are serialized."
"documentation":"<p>Describes how the results of the Select job are serialized.</p>"
}
},
"documentation":"Describes the parameters for Select job types."
"documentation":"<p>Describes the parameters for Select job types.</p>"
},
"ServerSideEncryption":{
"type":"string",
@ -6495,14 +6496,14 @@
"members":{
"SSEAlgorithm":{
"shape":"ServerSideEncryption",
"documentation":"Server-side encryption algorithm to use for the default encryption."
"documentation":"<p>Server-side encryption algorithm to use for the default encryption.</p>"
},
"KMSMasterKeyID":{
"shape":"SSEKMSKeyId",
"documentation":"KMS master key ID to use for the default encryption. This parameter is allowed if SSEAlgorithm is aws:kms."
"documentation":"<p>KMS master key ID to use for the default encryption. This parameter is allowed if SSEAlgorithm is aws:kms.</p>"
}
},
"documentation":"Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied."
"documentation":"<p>Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied.</p>"
},
"ServerSideEncryptionConfiguration":{
"type":"structure",
@ -6510,21 +6511,21 @@
"members":{
"Rules":{
"shape":"ServerSideEncryptionRules",
"documentation":"Container for information about a particular server-side encryption configuration rule.",
"documentation":"<p>Container for information about a particular server-side encryption configuration rule.</p>",
"locationName":"Rule"
}
},
"documentation":"Container for server-side encryption configuration rules. Currently S3 supports one rule only."
"documentation":"<p>Container for server-side encryption configuration rules. Currently S3 supports one rule only.</p>"
},
"ServerSideEncryptionRule":{
"type":"structure",
"members":{
"ApplyServerSideEncryptionByDefault":{
"shape":"ServerSideEncryptionByDefault",
"documentation":"Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied."
"documentation":"<p>Describes the default server-side encryption to apply to new objects in the bucket. If Put Object request does not specify any server-side encryption, this default encryption will be applied.</p>"
}
},
"documentation":"Container for information about a particular server-side encryption configuration rule."
"documentation":"<p>Container for information about a particular server-side encryption configuration rule.</p>"
},
"ServerSideEncryptionRules":{
"type":"list",
@ -6537,10 +6538,10 @@
"members":{
"SseKmsEncryptedObjects":{
"shape":"SseKmsEncryptedObjects",
"documentation":"Container for filter information of selection of KMS Encrypted S3 objects."
"documentation":"<p>Container for filter information of selection of KMS Encrypted S3 objects.</p>"
}
},
"documentation":"Container for filters that define which source objects should be replicated."
"documentation":"<p>Container for filters that define which source objects should be replicated.</p>"
},
"SseKmsEncryptedObjects":{
"type":"structure",
@ -6548,10 +6549,10 @@
"members":{
"Status":{
"shape":"SseKmsEncryptedObjectsStatus",
"documentation":"The replication for KMS encrypted S3 objects is disabled if status is not Enabled."
"documentation":"<p>The replication for KMS encrypted S3 objects is disabled if status is not Enabled.</p>"
}
},
"documentation":"Container for filter information of selection of KMS Encrypted S3 objects."
"documentation":"<p>Container for filter information of selection of KMS Encrypted S3 objects.</p>"
},
"SseKmsEncryptedObjectsStatus":{
"type":"string",
@ -6566,15 +6567,15 @@
"members":{
"BytesScanned":{
"shape":"BytesScanned",
"documentation":"Total number of object bytes scanned."
"documentation":"<p>Total number of object bytes scanned.</p>"
},
"BytesProcessed":{
"shape":"BytesProcessed",
"documentation":"Total number of uncompressed object bytes processed."
"documentation":"<p>Total number of uncompressed object bytes processed.</p>"
},
"BytesReturned":{
"shape":"BytesReturned",
"documentation":"Total number of bytes of records payload data returned."
"documentation":"<p>Total number of bytes of records payload data returned.</p>"
}
}
},
@ -6583,7 +6584,7 @@
"members":{
"Details":{
"shape":"Stats",
"documentation":"The Stats event details.",
"documentation":"<p>The Stats event details.</p>",
"eventpayload":true
}
},
@ -6603,7 +6604,7 @@
"members":{
"DataExport":{
"shape":"StorageClassAnalysisDataExport",
"documentation":"A container used to describe how data related to the storage class analysis should be exported."
"documentation":"<p>A container used to describe how data related to the storage class analysis should be exported.</p>"
}
}
},
@ -6616,11 +6617,11 @@
"members":{
"OutputSchemaVersion":{
"shape":"StorageClassAnalysisSchemaVersion",
"documentation":"The version of the output schema to use when exporting data. Must be V_1."
"documentation":"<p>The version of the output schema to use when exporting data. Must be V_1.</p>"
},
"Destination":{
"shape":"AnalyticsExportDestination",
"documentation":"The place to store the data for an analysis."
"documentation":"<p>The place to store the data for an analysis.</p>"
}
}
},
@ -6638,11 +6639,11 @@
"members":{
"Key":{
"shape":"ObjectKey",
"documentation":"Name of the tag."
"documentation":"<p>Name of the tag.</p>"
},
"Value":{
"shape":"Value",
"documentation":"Value of the tag."
"documentation":"<p>Value of the tag.</p>"
}
}
},
@ -6676,7 +6677,7 @@
"Grantee":{"shape":"Grantee"},
"Permission":{
"shape":"BucketLogsPermission",
"documentation":"Logging permissions assigned to the Grantee for the bucket."
"documentation":"<p>Logging permissions assigned to the Grantee for the bucket.</p>"
}
}
},
@ -6708,7 +6709,7 @@
"Id":{"shape":"NotificationId"},
"TopicArn":{
"shape":"TopicArn",
"documentation":"Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.",
"documentation":"<p>Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.</p>",
"locationName":"Topic"
},
"Events":{
@ -6717,7 +6718,7 @@
},
"Filter":{"shape":"NotificationConfigurationFilter"}
},
"documentation":"Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic."
"documentation":"<p>Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic.</p>"
},
"TopicConfigurationDeprecated":{
"type":"structure",
@ -6729,12 +6730,12 @@
},
"Event":{
"shape":"Event",
"documentation":"Bucket event for which to send notifications.",
"documentation":"<p>Bucket event for which to send notifications.</p>",
"deprecated":true
},
"Topic":{
"shape":"TopicArn",
"documentation":"Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket."
"documentation":"<p>Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.</p>"
}
}
},
@ -6748,15 +6749,15 @@
"members":{
"Date":{
"shape":"Date",
"documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format."
"documentation":"<p>Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.</p>"
},
"Days":{
"shape":"Days",
"documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer."
"documentation":"<p>Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.</p>"
},
"StorageClass":{
"shape":"TransitionStorageClass",
"documentation":"The class of storage used to store the object."
"documentation":"<p>The class of storage used to store the object.</p>"
}
}
},
@ -6788,32 +6789,32 @@
"members":{
"CopySourceVersionId":{
"shape":"CopySourceVersionId",
"documentation":"The version of the source object that was copied, if you have enabled versioning on the source bucket.",
"documentation":"<p>The version of the source object that was copied, if you have enabled versioning on the source bucket.</p>",
"location":"header",
"locationName":"x-amz-copy-source-version-id"
},
"CopyPartResult":{"shape":"CopyPartResult"},
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -6842,37 +6843,37 @@
},
"CopySource":{
"shape":"CopySource",
"documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.",
"documentation":"<p>The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.</p>",
"location":"header",
"locationName":"x-amz-copy-source"
},
"CopySourceIfMatch":{
"shape":"CopySourceIfMatch",
"documentation":"Copies the object if its entity tag (ETag) matches the specified tag.",
"documentation":"<p>Copies the object if its entity tag (ETag) matches the specified tag.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-match"
},
"CopySourceIfModifiedSince":{
"shape":"CopySourceIfModifiedSince",
"documentation":"Copies the object if it has been modified since the specified time.",
"documentation":"<p>Copies the object if it has been modified since the specified time.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-modified-since"
},
"CopySourceIfNoneMatch":{
"shape":"CopySourceIfNoneMatch",
"documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag.",
"documentation":"<p>Copies the object if its entity tag (ETag) is different than the specified ETag.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-none-match"
},
"CopySourceIfUnmodifiedSince":{
"shape":"CopySourceIfUnmodifiedSince",
"documentation":"Copies the object if it hasn't been modified since the specified time.",
"documentation":"<p>Copies the object if it hasn't been modified since the specified time.</p>",
"location":"header",
"locationName":"x-amz-copy-source-if-unmodified-since"
},
"CopySourceRange":{
"shape":"CopySourceRange",
"documentation":"The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.",
"documentation":"<p>The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.</p>",
"location":"header",
"locationName":"x-amz-copy-source-range"
},
@ -6883,49 +6884,49 @@
},
"PartNumber":{
"shape":"PartNumber",
"documentation":"Part number of part being copied. This is a positive integer between 1 and 10,000.",
"documentation":"<p>Part number of part being copied. This is a positive integer between 1 and 10,000.</p>",
"location":"querystring",
"locationName":"partNumber"
},
"UploadId":{
"shape":"MultipartUploadId",
"documentation":"Upload ID identifying the multipart upload whose part is being copied.",
"documentation":"<p>Upload ID identifying the multipart upload whose part is being copied.</p>",
"location":"querystring",
"locationName":"uploadId"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"CopySourceSSECustomerAlgorithm":{
"shape":"CopySourceSSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use when decrypting the source object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm"
},
"CopySourceSSECustomerKey":{
"shape":"CopySourceSSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.</p>",
"location":"header",
"locationName":"x-amz-copy-source-server-side-encryption-customer-key"
},
"CopySourceSSECustomerKeyMD5":{
"shape":"CopySourceSSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5"
},
@ -6941,31 +6942,31 @@
"members":{
"ServerSideEncryption":{
"shape":"ServerSideEncryption",
"documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).",
"documentation":"<p>The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption"
},
"ETag":{
"shape":"ETag",
"documentation":"Entity tag for the uploaded object.",
"documentation":"<p>Entity tag for the uploaded object.</p>",
"location":"header",
"locationName":"ETag"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.",
"documentation":"<p>If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
"SSEKMSKeyId":{
"shape":"SSEKMSKeyId",
"documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.",
"documentation":"<p>If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-aws-kms-key-id"
},
@ -6987,60 +6988,60 @@
"members":{
"Body":{
"shape":"Body",
"documentation":"Object data.",
"documentation":"<p>Object data.</p>",
"streaming":true
},
"Bucket":{
"shape":"BucketName",
"documentation":"Name of the bucket to which the multipart upload was initiated.",
"documentation":"<p>Name of the bucket to which the multipart upload was initiated.</p>",
"location":"uri",
"locationName":"Bucket"
},
"ContentLength":{
"shape":"ContentLength",
"documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.",
"documentation":"<p>Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.</p>",
"location":"header",
"locationName":"Content-Length"
},
"ContentMD5":{
"shape":"ContentMD5",
"documentation":"The base64-encoded 128-bit MD5 digest of the part data.",
"documentation":"<p>The base64-encoded 128-bit MD5 digest of the part data.</p>",
"location":"header",
"locationName":"Content-MD5"
},
"Key":{
"shape":"ObjectKey",
"documentation":"Object key for which the multipart upload was initiated.",
"documentation":"<p>Object key for which the multipart upload was initiated.</p>",
"location":"uri",
"locationName":"Key"
},
"PartNumber":{
"shape":"PartNumber",
"documentation":"Part number of part being uploaded. This is a positive integer between 1 and 10,000.",
"documentation":"<p>Part number of part being uploaded. This is a positive integer between 1 and 10,000.</p>",
"location":"querystring",
"locationName":"partNumber"
},
"UploadId":{
"shape":"MultipartUploadId",
"documentation":"Upload ID identifying the multipart upload whose part is being uploaded.",
"documentation":"<p>Upload ID identifying the multipart upload whose part is being uploaded.</p>",
"location":"querystring",
"locationName":"uploadId"
},
"SSECustomerAlgorithm":{
"shape":"SSECustomerAlgorithm",
"documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).",
"documentation":"<p>Specifies the algorithm to use to when encrypting the object (e.g., AES256).</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-algorithm"
},
"SSECustomerKey":{
"shape":"SSECustomerKey",
"documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.",
"documentation":"<p>Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key"
},
"SSECustomerKeyMD5":{
"shape":"SSECustomerKeyMD5",
"documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.",
"documentation":"<p>Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.</p>",
"location":"header",
"locationName":"x-amz-server-side-encryption-customer-key-MD5"
},
@ -7066,12 +7067,12 @@
"members":{
"MFADelete":{
"shape":"MFADelete",
"documentation":"Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.",
"documentation":"<p>Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.</p>",
"locationName":"MfaDelete"
},
"Status":{
"shape":"BucketVersioningStatus",
"documentation":"The versioning state of the bucket."
"documentation":"<p>The versioning state of the bucket.</p>"
}
}
},

557
botocore/data/sagemaker/2017-07-24/service-2.json
View file

@ -2,7 +2,7 @@
"version":"2.0",
"metadata":{
"apiVersion":"2017-07-24",
"endpointPrefix":"sagemaker",
"endpointPrefix":"api.sagemaker",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"SageMaker",
@ -127,6 +127,20 @@
],
"documentation":"<p>Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. </p> <p>If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a deep learning service other than Amazon SageMaker, provided that you know how to use them for inferences. </p> <p>In the request body, you provide the following: </p> <ul> <li> <p> <code>AlgorithmSpecification</code> - Identifies the training algorithm to use. </p> </li> <li> <p> <code>HyperParameters</code> - Specify these algorithm-specific parameters to influence the quality of the final model. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/algos.html\">Algorithms</a>. </p> </li> <li> <p> <code>InputDataConfig</code> - Describes the training dataset and the Amazon S3 location where it is stored.</p> </li> <li> <p> <code>OutputDataConfig</code> - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results of model training. </p> <p/> </li> <li> <p> <code>ResourceConfig</code> - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. </p> </li> <li> <p> <code>RoleARN</code> - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training. </p> </li> <li> <p> <code>StoppingCondition</code> - Sets a duration for training. Use this parameter to cap model training costs. </p> </li> </ul> <p> For more information about Amazon SageMaker, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html\">How It Works</a>. </p>"
},
"CreateTransformJob":{
"name":"CreateTransformJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTransformJobRequest"},
"output":{"shape":"CreateTransformJobResponse"},
"errors":[
{"shape":"ResourceInUse"},
{"shape":"ResourceLimitExceeded"}
],
"documentation":"<p>Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.</p> <p>To perform batch transformations, you create a transform job and use the data that you have readily available.</p> <p>In the request body, you provide the following:</p> <ul> <li> <p> <code>TransformJobName</code> - Identifies the transform job. The name must be unique within an AWS Region in an AWS account.</p> </li> <li> <p> <code>ModelName</code> - Identifies the model to use. <code>ModelName</code> must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.</p> </li> <li> <p> <code>TransformInput</code> - Describes the dataset to be transformed and the Amazon S3 location where it is stored.</p> </li> <li> <p> <code>TransformOutput</code> - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.</p> </li> <li> <p> <code>TransformResources</code> - Identifies the ML compute instances for the transform job.</p> </li> </ul> <p> For more information about how batch transformation works Amazon SageMaker, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html\">How It Works</a>. </p>"
},
"DeleteEndpoint":{
"name":"DeleteEndpoint",
"http":{
@ -134,7 +148,7 @@
"requestUri":"/"
},
"input":{"shape":"DeleteEndpointInput"},
"documentation":"<p>Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created. </p>"
"documentation":"<p>Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created. </p> <p>Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the <a href=\"http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html\">RevokeGrant</a> API call.</p>"
},
"DeleteEndpointConfig":{
"name":"DeleteEndpointConfig",
@ -258,6 +272,19 @@
],
"documentation":"<p>Returns information about a training job.</p>"
},
"DescribeTransformJob":{
"name":"DescribeTransformJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTransformJobRequest"},
"output":{"shape":"DescribeTransformJobResponse"},
"errors":[
{"shape":"ResourceNotFound"}
],
"documentation":"<p>Returns information about a transform job.</p>"
},
"ListEndpointConfigs":{
"name":"ListEndpointConfigs",
"http":{
@ -351,6 +378,16 @@
],
"documentation":"<p>Gets a list of <a>TrainingJobSummary</a> objects that describe the training jobs that a hyperparameter tuning job launched.</p>"
},
"ListTransformJobs":{
"name":"ListTransformJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTransformJobsRequest"},
"output":{"shape":"ListTransformJobsResponse"},
"documentation":"<p>Lists transform jobs.</p>"
},
"StartNotebookInstance":{
"name":"StartNotebookInstance",
"http":{
@ -373,7 +410,7 @@
"errors":[
{"shape":"ResourceNotFound"}
],
"documentation":"<p>Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.</p> <p>All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write toAmazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the <code>Stopped</code> state, it releases all reserved resources for the tuning job.</p>"
"documentation":"<p>Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.</p> <p>All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the <code>Stopped</code> state, it releases all reserved resources for the tuning job.</p>"
},
"StopNotebookInstance":{
"name":"StopNotebookInstance",
@ -396,6 +433,18 @@
],
"documentation":"<p>Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the <code>SIGTERM</code> signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. </p> <p>Training algorithms provided by Amazon SageMaker save the intermediate results of a model training job. This intermediate data is a valid model artifact. You can use the model artifacts that are saved when Amazon SageMaker stops a training job to create a model. </p> <p>When it receives a <code>StopTrainingJob</code> request, Amazon SageMaker changes the status of the job to <code>Stopping</code>. After Amazon SageMaker stops the job, it sets the status to <code>Stopped</code>.</p>"
},
"StopTransformJob":{
"name":"StopTransformJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopTransformJobRequest"},
"errors":[
{"shape":"ResourceNotFound"}
],
"documentation":"<p>Stops a transform job.</p> <p>When Amazon SageMaker receives a <code>StopTransformJob</code> request, the status of the job changes to <code>Stopping</code>. After Amazon SageMaker stops the job, the status is set to <code>Stopped</code>. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.</p>"
},
"UpdateEndpoint":{
"name":"UpdateEndpoint",
"http":{
@ -450,6 +499,10 @@
}
},
"shapes":{
"Accept":{
"type":"string",
"max":256
},
"AddTagsInput":{
"type":"structure",
"required":[
@ -498,6 +551,20 @@
},
"documentation":"<p>Specifies the training algorithm to use in a <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateTrainingJob.html\">CreateTrainingJob</a> request.</p> <p>For more information about algorithms provided by Amazon SageMaker, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/algos.html\">Algorithms</a>. For information about using your own algorithms, see <a>your-algorithms</a>. </p>"
},
"AssemblyType":{
"type":"string",
"enum":[
"None",
"Line"
]
},
"BatchStrategy":{
"type":"string",
"enum":[
"MultiRecord",
"SingleRecord"
]
},
"CategoricalParameterRange":{
"type":"structure",
"required":[
@ -887,7 +954,7 @@
"members":{
"TrainingJobName":{
"shape":"TrainingJobName",
"documentation":"<p>The name of the training job. The name must be unique within an AWS Region in an AWS account. It appears in the Amazon SageMaker console. </p>"
"documentation":"<p>The name of the training job. The name must be unique within an AWS Region in an AWS account. </p>"
},
"HyperParameters":{
"shape":"HyperParameters",
@ -937,6 +1004,68 @@
}
}
},
"CreateTransformJobRequest":{
"type":"structure",
"required":[
"TransformJobName",
"ModelName",
"TransformInput",
"TransformOutput",
"TransformResources"
],
"members":{
"TransformJobName":{
"shape":"TransformJobName",
"documentation":"<p>The name of the transform job. The name must be unique within an AWS Region in an AWS account. </p>"
},
"ModelName":{
"shape":"ModelName",
"documentation":"<p>The name of the model that you want to use for the transform job. <code>ModelName</code> must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.</p>"
},
"MaxConcurrentTransforms":{
"shape":"MaxConcurrentTransforms",
"documentation":"<p>The maximum number of parallel requests that can be sent to each instance in a transform job. This is good for algorithms that implement multiple workers on larger instances . The default value is <code>1</code>. To allow Amazon SageMaker to determine the appropriate number for <code>MaxConcurrentTransforms</code>, set the value to <code>0</code>.</p>"
},
"MaxPayloadInMB":{
"shape":"MaxPayloadInMB",
"documentation":"<p>The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code> must be greater or equal to the size of a single record. You can approximate the size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the number of records you want in a mini-batch. It is recommended to enter a value slightly larger than this to ensure the records fit within the maximum payload size. The default value is <code>6</code> MB. For an unlimited payload size, set the value to <code>0</code>.</p>"
},
"BatchStrategy":{
"shape":"BatchStrategy",
"documentation":"<p>Determines the number of records included in a single mini-batch. <code>SingleRecord</code> means only one record is used per mini-batch. <code>MultiRecord</code> means a mini-batch is set to contain as many records that can fit within the <code>MaxPayloadInMB</code> limit.</p>"
},
"Environment":{
"shape":"TransformEnvironmentMap",
"documentation":"<p>The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.</p>"
},
"TransformInput":{
"shape":"TransformInput",
"documentation":"<p>Describes the input source and the way the transform job consumes it.</p>"
},
"TransformOutput":{
"shape":"TransformOutput",
"documentation":"<p>Describes the results of the transform job.</p>"
},
"TransformResources":{
"shape":"TransformResources",
"documentation":"<p>Describes the resources, including ML instance types and ML instance count, to use for the transform job.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>An array of key-value pairs. Adding tags is optional. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p>"
}
}
},
"CreateTransformJobResponse":{
"type":"structure",
"required":["TransformJobArn"],
"members":{
"TransformJobArn":{
"shape":"TransformJobArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the transform job.</p>"
}
}
},
"CreationTime":{"type":"timestamp"},
"DataSource":{
"type":"structure",
@ -1419,7 +1548,7 @@
},
"SecondaryStatus":{
"shape":"SecondaryStatus",
"documentation":"<p> Provides granular information about the system state. For more information, see <code>TrainingJobStatus</code>. </p>"
"documentation":"<p> Provides granular information about the system state. For more information, see <code>TrainingJobStatus</code>. </p> <ul> <li> <p> <code>Starting</code> - starting the training job.</p> </li> <li> <p> <code>LaunchingMLInstances</code> - launching ML instances for the training job.</p> </li> <li> <p> <code>PreparingTrainingStack</code> - preparing the ML instances for the training job.</p> </li> <li> <p> <code>Downloading</code> - downloading the input data.</p> </li> <li> <p> <code>DownloadingTrainingImage</code> - downloading the training algorithm image.</p> </li> <li> <p> <code>Training</code> - model training is in progress.</p> </li> <li> <p> <code>Uploading</code> - uploading the trained model.</p> </li> <li> <p> <code>Stopping</code> - stopping the training job.</p> </li> <li> <p> <code>Stopped</code> - the training job has stopped.</p> </li> <li> <p> <code>MaxRuntimeExceeded</code> - the training exceed the specified the max run time, which means the training job is stopping.</p> </li> <li> <p> <code>Completed</code> - the training job has completed.</p> </li> <li> <p> <code>Failed</code> - the training job has failed. The failure reason is provided in the <code>StatusMessage</code>.</p> </li> </ul> <important> <p>The valid values for <code>SecondaryStatus</code> are subject to change. They primary provide information on the progress of the training job.</p> </important>"
},
"FailureReason":{
"shape":"FailureReason",
@ -1472,6 +1601,94 @@
"LastModifiedTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp that indicates when the status of the training job was last modified.</p>"
},
"SecondaryStatusTransitions":{
"shape":"SecondaryStatusTransitions",
"documentation":"<p>A log of time-ordered secondary statuses that a training job has transitioned.</p>"
}
}
},
"DescribeTransformJobRequest":{
"type":"structure",
"required":["TransformJobName"],
"members":{
"TransformJobName":{
"shape":"TransformJobName",
"documentation":"<p>The name of the transform job that you want to view details of.</p>"
}
}
},
"DescribeTransformJobResponse":{
"type":"structure",
"required":[
"TransformJobName",
"TransformJobArn",
"TransformJobStatus",
"ModelName",
"TransformInput",
"TransformResources",
"CreationTime"
],
"members":{
"TransformJobName":{
"shape":"TransformJobName",
"documentation":"<p>The name of the transform job.</p>"
},
"TransformJobArn":{
"shape":"TransformJobArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the transform job.</p>"
},
"TransformJobStatus":{
"shape":"TransformJobStatus",
"documentation":"<p>The status of the transform job. If the transform job failed, the reason is returned in the <code>FailureReason</code> field.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the transform job failed, the reason that it failed.</p>"
},
"ModelName":{
"shape":"ModelName",
"documentation":"<p>The name of the model used in the transform job.</p>"
},
"MaxConcurrentTransforms":{
"shape":"MaxConcurrentTransforms",
"documentation":"<p>The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.</p>"
},
"MaxPayloadInMB":{
"shape":"MaxPayloadInMB",
"documentation":"<p>The maximum payload size , in MB used in the transform job.</p>"
},
"BatchStrategy":{
"shape":"BatchStrategy",
"documentation":"<p>SingleRecord means only one record was used per a batch. <code>MultiRecord</code> means batches contained as many records that could possibly fit within the <code>MaxPayloadInMB</code> limit.</p>"
},
"Environment":{
"shape":"TransformEnvironmentMap",
"documentation":"<p/>"
},
"TransformInput":{
"shape":"TransformInput",
"documentation":"<p>Describes the dataset to be transformed and the Amazon S3 location where it is stored.</p>"
},
"TransformOutput":{
"shape":"TransformOutput",
"documentation":"<p>Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.</p>"
},
"TransformResources":{
"shape":"TransformResources",
"documentation":"<p>Describes the resources, including ML instance types and ML instance count, to use for the transform job.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp that shows when the transform Job was created.</p>"
},
"TransformStartTime":{
"shape":"Timestamp",
"documentation":"<p>Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of <code>TransformEndTime</code>.</p>"
},
"TransformEndTime":{
"shape":"Timestamp",
"documentation":"<p>Indicates when the transform job is <code>Completed</code>, <code>Stopped</code>, or <code>Failed</code>. You are billed for the time interval between this time and the value of <code>TransformStartTime</code>.</p>"
}
}
},
@ -2431,7 +2648,7 @@
},
"CreationTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>A filter that only training jobs created after the specified time (timestamp).</p>"
"documentation":"<p>A filter that returns only training jobs created after the specified time (timestamp).</p>"
},
"CreationTimeBefore":{
"shape":"Timestamp",
@ -2477,6 +2694,70 @@
}
}
},
"ListTransformJobsRequest":{
"type":"structure",
"members":{
"CreationTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>A filter that returns only transform jobs created after the specified time.</p>"
},
"CreationTimeBefore":{
"shape":"Timestamp",
"documentation":"<p>A filter that returns only transform jobs created before the specified time.</p>"
},
"LastModifiedTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>A filter that returns only transform jobs modified after the specified time.</p>"
},
"LastModifiedTimeBefore":{
"shape":"Timestamp",
"documentation":"<p>A filter that returns only transform jobs modified before the specified time.</p>"
},
"NameContains":{
"shape":"NameContains",
"documentation":"<p>A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.</p>"
},
"StatusEquals":{
"shape":"TransformJobStatus",
"documentation":"<p>A filter that retrieves only transform jobs with a specific status.</p>"
},
"SortBy":{
"shape":"SortBy",
"documentation":"<p>The field to sort results by. The default is <code>CreationTime</code>.</p>"
},
"SortOrder":{
"shape":"SortOrder",
"documentation":"<p>The sort order for results. The default is <code>Descending</code>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous <code>ListTransformJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of transform jobs, use the token in the next request.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of transform jobs to return in the response. The default value is <code>10</code>.</p>",
"box":true
}
}
},
"ListTransformJobsResponse":{
"type":"structure",
"required":["TransformJobSummaries"],
"members":{
"TransformJobSummaries":{
"shape":"TransformJobSummaries",
"documentation":"<p>An array of <code>TransformJobSummary</code> objects.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.</p>"
}
}
},
"MaxConcurrentTransforms":{
"type":"integer",
"min":0
},
"MaxNumberOfTrainingJobs":{
"type":"integer",
"min":1
@ -2485,6 +2766,10 @@
"type":"integer",
"min":1
},
"MaxPayloadInMB":{
"type":"integer",
"min":0
},
"MaxResults":{
"type":"integer",
"max":100,
@ -3092,7 +3377,10 @@
"type":"string",
"enum":[
"Starting",
"LaunchingMLInstances",
"PreparingTrainingStack",
"Downloading",
"DownloadingTrainingImage",
"Training",
"Uploading",
"Stopping",
@ -3102,6 +3390,36 @@
"Failed"
]
},
"SecondaryStatusTransition":{
"type":"structure",
"required":[
"Status",
"StartTime"
],
"members":{
"Status":{
"shape":"SecondaryStatus",
"documentation":"<p>Provides granular information about the system state. For more information, see <code>SecondaryStatus</code> under the <a>DescribeTrainingJob</a> response elements.</p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp that shows when the training job has entered this secondary status.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp that shows when the secondary status has ended and the job has transitioned into another secondary status. </p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>Shows a brief description and other information about the secondary status. For example, the <code>LaunchingMLInstances</code> secondary status could show a status message of \"Insufficent capacity error while launching instances\".</p>"
}
},
"documentation":"<p>Specifies a secondary status the job has transitioned into. It includes a start timestamp and later an end timestamp. The end timestamp is added either after the job transitions to a different secondary status or after the job has ended.</p>"
},
"SecondaryStatusTransitions":{
"type":"list",
"member":{"shape":"SecondaryStatusTransition"}
},
"SecurityGroupId":{
"type":"string",
"max":32
@ -3131,6 +3449,14 @@
"Descending"
]
},
"SplitType":{
"type":"string",
"enum":[
"None",
"Line",
"RecordIO"
]
},
"StartNotebookInstanceInput":{
"type":"structure",
"required":["NotebookInstanceName"],
@ -3141,6 +3467,7 @@
}
}
},
"StatusMessage":{"type":"string"},
"StopHyperParameterTuningJobRequest":{
"type":"structure",
"required":["HyperParameterTuningJobName"],
@ -3171,6 +3498,16 @@
}
}
},
"StopTransformJobRequest":{
"type":"structure",
"required":["TransformJobName"],
"members":{
"TransformJobName":{
"shape":"TransformJobName",
"documentation":"<p>The name of the transform job to stop.</p>"
}
}
},
"StoppingCondition":{
"type":"structure",
"members":{
@ -3380,6 +3717,214 @@
},
"documentation":"<p>Provides summary information about a training job.</p>"
},
"TransformDataSource":{
"type":"structure",
"required":["S3DataSource"],
"members":{
"S3DataSource":{
"shape":"TransformS3DataSource",
"documentation":"<p>The S3 location of the data source that is associated with a channel.</p>"
}
},
"documentation":"<p>Describes the location of the channel data.</p>"
},
"TransformEnvironmentKey":{
"type":"string",
"max":1024,
"pattern":"[a-zA-Z_][a-zA-Z0-9_]*"
},
"TransformEnvironmentMap":{
"type":"map",
"key":{"shape":"TransformEnvironmentKey"},
"value":{"shape":"TransformEnvironmentValue"},
"max":16
},
"TransformEnvironmentValue":{
"type":"string",
"max":10240
},
"TransformInput":{
"type":"structure",
"required":["DataSource"],
"members":{
"DataSource":{
"shape":"TransformDataSource",
"documentation":"<p>Describes the location of the channel data, meaning the S3 location of the input data that the model can consume.</p>"
},
"ContentType":{
"shape":"ContentType",
"documentation":"<p>The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.</p>"
},
"CompressionType":{
"shape":"CompressionType",
"documentation":"<p>Compressing data helps save on storage space. If your transform data is compressed, specify the compression type.and Amazon SageMaker will automatically decompress the data for the transform job accordingly. The default value is <code>None</code>.</p>"
},
"SplitType":{
"shape":"SplitType",
"documentation":"<p>The method to use to split the transform job's data into smaller batches. The default value is <code>None</code>. If you don't want to split the data, specify <code>None</code>. If you want to split records on a newline character boundary, specify <code>Line</code>. To split records according to the RecordIO format, specify <code>RecordIO</code>.</p> <p>Amazon SageMaker will send maximum number of records per batch in each request up to the MaxPayloadInMB limit. For more information, see <a href=\"http://mxnet.io/architecture/note_data_loading.html#data-format\">RecordIO data format</a>.</p> <note> <p>For information about the <code>RecordIO</code> format, see <a href=\"http://mxnet.io/architecture/note_data_loading.html#data-format\">Data Format</a>.</p> </note>"
}
},
"documentation":"<p>Describes the input source of a transform job and the way the transform job consumes it.</p>"
},
"TransformInstanceCount":{
"type":"integer",
"min":1
},
"TransformInstanceType":{
"type":"string",
"enum":[
"ml.m4.xlarge",
"ml.m4.2xlarge",
"ml.m4.4xlarge",
"ml.m4.10xlarge",
"ml.m4.16xlarge",
"ml.c4.xlarge",
"ml.c4.2xlarge",
"ml.c4.4xlarge",
"ml.c4.8xlarge",
"ml.p2.xlarge",
"ml.p2.8xlarge",
"ml.p2.16xlarge",
"ml.p3.2xlarge",
"ml.p3.8xlarge",
"ml.p3.16xlarge",
"ml.c5.xlarge",
"ml.c5.2xlarge",
"ml.c5.4xlarge",
"ml.c5.9xlarge",
"ml.c5.18xlarge",
"ml.m5.large",
"ml.m5.xlarge",
"ml.m5.2xlarge",
"ml.m5.4xlarge",
"ml.m5.12xlarge",
"ml.m5.24xlarge"
]
},
"TransformJobArn":{
"type":"string",
"max":256,
"pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*"
},
"TransformJobName":{
"type":"string",
"max":63,
"min":1,
"pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*"
},
"TransformJobStatus":{
"type":"string",
"enum":[
"InProgress",
"Completed",
"Failed",
"Stopping",
"Stopped"
]
},
"TransformJobSummaries":{
"type":"list",
"member":{"shape":"TransformJobSummary"}
},
"TransformJobSummary":{
"type":"structure",
"required":[
"TransformJobName",
"TransformJobArn",
"CreationTime",
"TransformJobStatus"
],
"members":{
"TransformJobName":{
"shape":"TransformJobName",
"documentation":"<p>The name of the transform job.</p>"
},
"TransformJobArn":{
"shape":"TransformJobArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the transform job.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>A timestamp that shows when the transform Job was created.</p>"
},
"TransformEndTime":{
"shape":"Timestamp",
"documentation":"<p>Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.</p>"
},
"LastModifiedTime":{
"shape":"Timestamp",
"documentation":"<p>Indicates when the transform job was last modified.</p>"
},
"TransformJobStatus":{
"shape":"TransformJobStatus",
"documentation":"<p>The status of the transform job.</p>"
},
"FailureReason":{
"shape":"FailureReason",
"documentation":"<p>If the transform job failed, the reason it failed.</p>"
}
},
"documentation":"<p>Provides a summary information for a transform job. Multiple TransformJobSummary objects are returned as a list after calling <a>ListTransformJobs</a>.</p>"
},
"TransformOutput":{
"type":"structure",
"required":["S3OutputPath"],
"members":{
"S3OutputPath":{
"shape":"S3Uri",
"documentation":"<p>The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, <code>s3://bucket-name/key-name-prefix</code>.</p> <p>For every S3 object used as input for the transform job, the transformed data is stored in a corresponding subfolder in the location under the output prefix. For example, the input data <code>s3://bucket-name/input-name-prefix/dataset01/data.csv</code> will have the transformed data stored at <code>s3://bucket-name/key-name-prefix/dataset01/</code>, based on the original name, as a series of .part files (.part0001, part0002, etc).</p>"
},
"Accept":{
"shape":"Accept",
"documentation":"<p>The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.</p>"
},
"AssembleWith":{
"shape":"AssemblyType",
"documentation":"<p>Defines how to assemble the results of the transform job as a single S3 object. You should select a format that is most convenient to you. To concatenate the results in binary format, specify <code>None</code>. To add a newline character at the end of every transformed record, specify <code>Line</code>. To assemble the output in RecordIO format, specify <code>RecordIO</code>. The default value is <code>None</code>.</p> <p>For information about the <code>RecordIO</code> format, see <a href=\"http://mxnet.io/architecture/note_data_loading.html#data-format\">Data Format</a>.</p>"
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The AWS Key Management Service (AWS KMS) key for Amazon S3 server-side encryption that Amazon SageMaker uses to encrypt the transformed data.</p> <p>If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">KMS-Managed Encryption Keys</a> in the <i>Amazon Simple Storage Service Developer Guide.</i> </p> <p>The KMS key policy must grant permission to the IAM role that you specify in your <code>CreateTramsformJob</code> request. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html\">Using Key Policies in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>Describes the results of a transform job output.</p>"
},
"TransformResources":{
"type":"structure",
"required":[
"InstanceType",
"InstanceCount"
],
"members":{
"InstanceType":{
"shape":"TransformInstanceType",
"documentation":"<p>The ML compute instance type for the transform job. For using built-in algorithms to transform moderately sized datasets, ml.m4.xlarge or <code>ml.m5.large</code> should suffice. There is no default value for <code>InstanceType</code>.</p>"
},
"InstanceCount":{
"shape":"TransformInstanceCount",
"documentation":"<p>The number of ML compute instances to use in the transform job. For distributed transform, provide a value greater than 1. The default value is <code>1</code>.</p>"
}
},
"documentation":"<p>Describes the resources, including ML instance types and ML instance count, to use for transform job.</p>"
},
"TransformS3DataSource":{
"type":"structure",
"required":[
"S3DataType",
"S3Uri"
],
"members":{
"S3DataType":{
"shape":"S3DataType",
"documentation":"<p>If you choose <code>S3Prefix</code>, <code>S3Uri</code> identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform. </p> <p>If you choose <code>ManifestFile</code>, <code>S3Uri</code> identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform. </p>"
},
"S3Uri":{
"shape":"S3Uri",
"documentation":"<p>Depending on the value specified for the <code>S3DataType</code>, identifies either a key name prefix or a manifest. For example:</p> <ul> <li> <p> A key name prefix might look like this: <code>s3://bucketname/exampleprefix</code>. </p> </li> <li> <p> A manifest might look like this: <code>s3://bucketname/example.manifest</code> </p> <p> The manifest is an S3 object which is a JSON file with the following format: </p> <p> <code>[</code> </p> <p> <code> {\"prefix\": \"s3://customer_bucket/some/prefix/\"},</code> </p> <p> <code> \"relative/path/to/custdata-1\",</code> </p> <p> <code> \"relative/path/custdata-2\",</code> </p> <p> <code> ...</code> </p> <p> <code> ]</code> </p> <p> The preceding JSON matches the following <code>S3Uris</code>: </p> <p> <code>s3://customer_bucket/some/prefix/relative/path/to/custdata-1</code> </p> <p> <code>s3://customer_bucket/some/prefix/relative/path/custdata-1</code> </p> <p> <code>...</code> </p> <p> The complete set of <code>S3Uris</code> in this manifest constitutes the input data for the channel for this datasource. The object that each <code>S3Uris</code> points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.</p> </li> </ul>"
}
},
"documentation":"<p>Describes the S3 data source.</p>"
},
"UpdateEndpointInput":{
"type":"structure",
"required":[

25
botocore/data/secretsmanager/2017-10-17/service-2.json
View file

@ -289,7 +289,7 @@
{"shape":"InternalServiceError"},
{"shape":"PreconditionNotMetException"}
],
"documentation":"<p>Modifies many of the details of a secret. If you include a <code>ClientRequestToken</code> and either <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version attached to the secret.</p> <p>To modify the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If a version with a <code>SecretVersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists, the operation generates an error. You cannot modify an existing version, you can only create new ones.</p> </li> <li> <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version. </p> </li> </ul> <note> <ul> <li> <p>If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:UpdateSecret</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> <li> <p>kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a new secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To add only a new version to an existing secret, use <a>PutSecretValue</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions contained in a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
"documentation":"<p>Modifies many of the details of the specified secret. If you include a <code>ClientRequestToken</code> and <i>either</i> <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version attached to the secret.</p> <p>To modify the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If a version with a <code>SecretVersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.</p> </li> <li> <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version. </p> </li> </ul> <note> <ul> <li> <p>If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:UpdateSecret</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> <li> <p>kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a new secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To add only a new version to an existing secret, use <a>PutSecretValue</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions contained in a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
},
"UpdateSecretVersionStage":{
"name":"UpdateSecretVersionStage",
@ -444,6 +444,11 @@
"shape":"RecoveryWindowInDaysType",
"documentation":"<p>(Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret.</p> <p>This value can range from 7 to 30 days. The default value is 30.</p>",
"box":true
},
"ForceDeleteWithoutRecovery":{
"shape":"BooleanType",
"documentation":"<p>(Optional) Specifies that the secret is to be deleted immediately without any recovery window. You cannot use both this parameter and the <code>RecoveryWindowInDays</code> parameter in the same API call.</p> <p>An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.</p> <important> <p>Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the <code>RecoveryWindowInDays</code> parameter. If you delete a secret with the <code>ForceDeleteWithouRecovery</code> parameter, then you have no opportunity to recover the secret. It is permanently lost.</p> </important>",
"box":true
}
}
},
@ -1252,7 +1257,7 @@
"members":{
"SecretId":{
"shape":"SecretIdType",
"documentation":"<p>Specifies the secret that you want to update or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>"
"documentation":"<p>Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestTokenType",
@ -1261,19 +1266,19 @@
},
"Description":{
"shape":"DescriptionType",
"documentation":"<p>(Optional) Specifies a user-provided description of the secret.</p>"
"documentation":"<p>(Optional) Specifies an updated user-provided description of the secret.</p>"
},
"KmsKeyId":{
"shape":"KmsKeyIdType",
"documentation":"<p>(Optional) Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the protected text in the versions of this secret.</p> <p>If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account (the one named <code>aws/secretsmanager</code>). If a AWS KMS CMK with that name doesn't exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's <code>Plaintext</code> or <code>PlaintextString</code> fields.</p> <important> <p>You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN in this field. </p> </important>"
"documentation":"<p>(Optional) Specifies an updated ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the protected text in new versions of this secret.</p> <important> <p>You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.</p> </important>"
},
"SecretBinary":{
"shape":"SecretBinaryType",
"documentation":"<p>(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either <code>SecretBinary</code> or <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p> <p>This parameter is not accessible using the Secrets Manager console.</p>"
"documentation":"<p>(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either <code>SecretBinary</code> or <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p> <p>This parameter is not accessible using the Secrets Manager console.</p>"
},
"SecretString":{
"shape":"SecretStringType",
"documentation":"<p>(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either <code>SecretBinary</code> or <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p> <p>If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.</p> <p>For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For example:</p> <p> <code>[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]</code> </p> <p>If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.</p>"
"documentation":"<p>(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either <code>SecretBinary</code> or <code>SecretString</code> must have a value, but not both. They cannot both be empty.</p> <p>If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.</p> <p>For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For example:</p> <p> <code>[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]</code> </p> <p>If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. You can also 'escape' the double quote character in the embedded JSON text by prefacing each with a backslash. For example, the following string is surrounded by double-quotes. All of the embedded double quotes are escaped:</p> <p> <code>\"[{\\\"username\\\":\\\"bob\\\"},{\\\"password\\\":\\\"abc123xyz456\\\"}]\"</code> </p>"
}
}
},
@ -1282,15 +1287,15 @@
"members":{
"ARN":{
"shape":"SecretARNType",
"documentation":"<p>The ARN of this secret.</p> <note> <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret <i>don't</i> automatically get access to the new secret because the ARNs are different.</p> </note>"
"documentation":"<p>The ARN of the secret that was updated.</p> <note> <p>Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret <i>don't</i> automatically get access to the new secret because the ARNs are different.</p> </note>"
},
"Name":{
"shape":"SecretNameType",
"documentation":"<p>The friendly name of this secret.</p>"
"documentation":"<p>The friendly name of the secret that was updated.</p>"
},
"VersionId":{
"shape":"SecretVersionIdType",
"documentation":"<p>If a version of the secret was created or updated by this operation, then its unique identifier is returned.</p>"
"documentation":"<p>If a new version of the secret was created by this operation, then <code>VersionId</code> contains the unique identifier of the new version.</p>"
}
}
},
@ -1316,7 +1321,7 @@
},
"MoveToVersionId":{
"shape":"SecretVersionIdType",
"documentation":"<p>(Optional) The secret version ID that you want to add the staging labels to.</p> <p>If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.</p>",
"documentation":"<p>(Optional) The secret version ID that you want to add the staging labels to.</p> <p>If any of the staging labels are already attached to a different version of the secret, then they are automatically removed from that version before adding them to this version.</p>",
"box":true
}
}

139
botocore/data/snowball/2016-06-30/service-2.json
View file

@ -41,7 +41,7 @@
{"shape":"InvalidJobStateException"},
{"shape":"KMSRequestFailedException"}
],
"documentation":"<p>Cancels the specified job. You can only cancel a job before its <code>JobState</code> value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or <code>DescribeJob</code> action will return a job's <code>JobState</code> as part of the response element data returned.</p>"
"documentation":"<p>Cancels the specified job. You can only cancel a job before its <code>JobState</code> value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or <code>DescribeJob</code> action returns a job's <code>JobState</code> as part of the response element data returned.</p>"
},
"CreateAddress":{
"name":"CreateAddress",
@ -68,7 +68,8 @@
"errors":[
{"shape":"InvalidResourceException"},
{"shape":"KMSRequestFailedException"},
{"shape":"InvalidInputCombinationException"}
{"shape":"InvalidInputCombinationException"},
{"shape":"Ec2RequestFailedException"}
],
"documentation":"<p>Creates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.</p>"
},
@ -84,7 +85,8 @@
{"shape":"InvalidResourceException"},
{"shape":"KMSRequestFailedException"},
{"shape":"InvalidInputCombinationException"},
{"shape":"ClusterLimitExceededException"}
{"shape":"ClusterLimitExceededException"},
{"shape":"Ec2RequestFailedException"}
],
"documentation":"<p>Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the <code>clusterId</code> value; the other job attributes are inherited from the cluster. </p>"
},
@ -206,6 +208,20 @@
],
"documentation":"<p>Returns an array of <code>ClusterListEntry</code> objects of the specified length. Each <code>ClusterListEntry</code> object contains a cluster's state, a cluster's ID, and other important status information.</p>"
},
"ListCompatibleImages":{
"name":"ListCompatibleImages",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCompatibleImagesRequest"},
"output":{"shape":"ListCompatibleImagesResult"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"Ec2RequestFailedException"}
],
"documentation":"<p>This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.</p>"
},
"ListJobs":{
"name":"ListJobs",
"http":{
@ -231,7 +247,8 @@
{"shape":"InvalidResourceException"},
{"shape":"InvalidJobStateException"},
{"shape":"KMSRequestFailedException"},
{"shape":"InvalidInputCombinationException"}
{"shape":"InvalidInputCombinationException"},
{"shape":"Ec2RequestFailedException"}
],
"documentation":"<p>While a cluster's <code>ClusterState</code> value is in the <code>AwaitingQuorum</code> state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.</p>"
},
@ -248,7 +265,8 @@
{"shape":"InvalidJobStateException"},
{"shape":"KMSRequestFailedException"},
{"shape":"InvalidInputCombinationException"},
{"shape":"ClusterLimitExceededException"}
{"shape":"ClusterLimitExceededException"},
{"shape":"Ec2RequestFailedException"}
],
"documentation":"<p>While a job's <code>JobState</code> value is <code>New</code>, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.</p>"
}
@ -326,6 +344,12 @@
"type":"list",
"member":{"shape":"Address"}
},
"AmiId":{
"type":"string",
"max":21,
"min":12,
"pattern":"(ami-[0-9a-f]{8})|(ami-[0-9a-f]{17})"
},
"Boolean":{"type":"boolean"},
"CancelClusterRequest":{
"type":"structure",
@ -426,7 +450,7 @@
},
"SnowballType":{
"shape":"SnowballType",
"documentation":"<p>The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is <code>EDGE</code>.</p>"
"documentation":"<p>The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p>"
},
"CreationDate":{
"shape":"Timestamp",
@ -442,7 +466,7 @@
},
"ShippingOption":{
"shape":"ShippingOption",
"documentation":"<p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:</p> <ul> <li> <p>In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.</p> </li> <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li> <li> <p>In India, Snowball Edges are delivered in one to seven days.</p> </li> <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li> </ul>"
"documentation":"<p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:</p> <ul> <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li> <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li> <li> <p>In India, Snowball Edges are delivered in one to seven days.</p> </li> <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li> </ul>"
},
"Notification":{
"shape":"Notification",
@ -465,6 +489,24 @@
"Cancelled"
]
},
"CompatibleImage":{
"type":"structure",
"members":{
"AmiId":{
"shape":"String",
"documentation":"<p>The unique identifier for an individual Snowball Edge AMI.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The optional name of a compatible image.</p>"
}
},
"documentation":"<p>A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snowball Edge AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.</p>"
},
"CompatibleImageList":{
"type":"list",
"member":{"shape":"CompatibleImage"}
},
"CreateAddressRequest":{
"type":"structure",
"required":["Address"],
@ -520,11 +562,11 @@
},
"SnowballType":{
"shape":"SnowballType",
"documentation":"<p>The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is <code>EDGE</code>.</p>"
"documentation":"<p>The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p>"
},
"ShippingOption":{
"shape":"ShippingOption",
"documentation":"<p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:</p> <ul> <li> <p>In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.</p> </li> <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li> <li> <p>In India, Snowball Edges are delivered in one to seven days.</p> </li> <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li> </ul>"
"documentation":"<p>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:</p> <ul> <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li> <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li> <li> <p>In India, Snowball Edges are delivered in one to seven days.</p> </li> <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li> </ul>"
},
"Notification":{
"shape":"Notification",
@ -590,7 +632,7 @@
},
"SnowballType":{
"shape":"SnowballType",
"documentation":"<p>The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is <code>EDGE</code>.</p>"
"documentation":"<p>The type of AWS Snowball device to use for this job. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</p>"
},
"ForwardingAddressId":{
"shape":"AddressId",
@ -627,7 +669,7 @@
"documentation":"<p>The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.</p>"
}
},
"documentation":"<p>Defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a <code>JobState</code> value of <code>InProgress</code>, for both import and export jobs.</p>"
"documentation":"<p>Defines the real-time status of a Snowball's data transfer while the device is at AWS. This data is only available while a job has a <code>JobState</code> value of <code>InProgress</code>, for both import and export jobs.</p>"
},
"DescribeAddressRequest":{
"type":"structure",
@ -716,6 +758,33 @@
}
}
},
"Ec2AmiResource":{
"type":"structure",
"required":["AmiId"],
"members":{
"AmiId":{
"shape":"AmiId",
"documentation":"<p>The ID of the AMI in Amazon EC2.</p>"
},
"SnowballAmiId":{
"shape":"String",
"documentation":"<p>The ID of the AMI on the Snowball Edge device.</p>"
}
},
"documentation":"<p>A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device.</p>"
},
"Ec2AmiResourceList":{
"type":"list",
"member":{"shape":"Ec2AmiResource"}
},
"Ec2RequestFailedException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.</p>",
"exception":true
},
"EventTriggerDefinition":{
"type":"structure",
"members":{
@ -822,7 +891,11 @@
"InvalidResourceException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
"Message":{"shape":"String"},
"ResourceType":{
"shape":"String",
"documentation":"<p>The provided resource value is invalid.</p>"
}
},
"documentation":"<p>The specified resource can't be found. Check the information you provided in your last request, and try again.</p>",
"exception":true
@ -854,7 +927,7 @@
},
"SnowballType":{
"shape":"SnowballType",
"documentation":"<p>The type of appliance used with this job.</p>"
"documentation":"<p>The type of device used with this job.</p>"
},
"CreationDate":{
"shape":"Timestamp",
@ -906,7 +979,7 @@
},
"SnowballType":{
"shape":"SnowballType",
"documentation":"<p>The type of appliance used with this job.</p>"
"documentation":"<p>The type of device used with this job.</p>"
},
"CreationDate":{
"shape":"Timestamp",
@ -946,7 +1019,7 @@
},
"DataTransferProgress":{
"shape":"DataTransfer",
"documentation":"<p>A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a <code>JobState</code> value of <code>InProgress</code>, for both import and export jobs.</p>"
"documentation":"<p>A value that defines the real-time status of a Snowball's data transfer while the device is at AWS. This data is only available while a job has a <code>JobState</code> value of <code>InProgress</code>, for both import and export jobs.</p>"
},
"JobLogInfo":{
"shape":"JobLogs",
@ -977,9 +1050,13 @@
"LambdaResources":{
"shape":"LambdaResourceList",
"documentation":"<p>The Python-language Lambda functions for this job.</p>"
},
"Ec2AmiResources":{
"shape":"Ec2AmiResourceList",
"documentation":"<p>The Amazon Machine Images (AMIs) associated with this job.</p>"
}
},
"documentation":"<p>Contains an array of <code>S3Resource</code> objects. Each <code>S3Resource</code> object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.</p>"
"documentation":"<p>Contains an array of AWS resource objects. Each object represents an Amazon S3 bucket, an AWS Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.</p>"
},
"JobState":{
"type":"string",
@ -1112,6 +1189,32 @@
}
}
},
"ListCompatibleImagesRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"ListLimit",
"documentation":"<p>The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>HTTP requests are stateless. To identify what object comes \"next\" in the list of compatible images, you can specify a value for <code>NextToken</code> as the starting point for your list of returned images.</p>"
}
}
},
"ListCompatibleImagesResult":{
"type":"structure",
"members":{
"CompatibleImages":{
"shape":"CompatibleImageList",
"documentation":"<p>A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snowball Edge AMI.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Because HTTP requests are stateless, this is the starting point for your next list of returned images.</p>"
}
}
},
"ListJobsRequest":{
"type":"structure",
"members":{
@ -1325,7 +1428,7 @@
},
"Resources":{
"shape":"JobResource",
"documentation":"<p>The updated <a>S3Resource</a> object (for a single Amazon S3 bucket or key range), or the updated <a>JobResource</a> object (for multiple buckets or key ranges). </p>"
"documentation":"<p>The updated <code>JobResource</code> object, or the updated <a>JobResource</a> object. </p>"
},
"AddressId":{
"shape":"AddressId",
@ -1355,5 +1458,5 @@
}
}
},
"documentation":"<p>AWS Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html\">User Guide</a>.</p>"
"documentation":"<p>AWS Snowball is a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball device, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html\">User Guide</a>.</p>"
}

171
botocore/data/ssm/2014-11-06/service-2.json
View file

@ -1028,6 +1028,23 @@
],
"documentation":"<p>Retrieves the patch baseline that should be used for the specified patch group.</p>"
},
"LabelParameterVersion":{
"name":"LabelParameterVersion",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"LabelParameterVersionRequest"},
"output":{"shape":"LabelParameterVersionResult"},
"errors":[
{"shape":"InternalServerError"},
{"shape":"TooManyUpdates"},
{"shape":"ParameterNotFound"},
{"shape":"ParameterVersionNotFound"},
{"shape":"ParameterVersionLabelLimitExceeded"}
],
"documentation":"<p>A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions. </p> <p>Parameter labels have the following requirements and restrictions.</p> <ul> <li> <p>A version of a parameter can have a maximum of 10 labels.</p> </li> <li> <p>You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.</p> </li> <li> <p>You can move a label from one version of a parameter to another.</p> </li> <li> <p>You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.</p> </li> <li> <p>You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.</p> </li> <li> <p>A label can have a maximum of 100 characters.</p> </li> <li> <p>Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).</p> </li> <li> <p>Labels can't begin with a number, \"aws,\" or \"ssm\" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.</p> </li> </ul>"
},
"ListAssociationVersions":{
"name":"ListAssociationVersions",
"http":{
@ -2359,6 +2376,10 @@
"shape":"Targets",
"documentation":"<p>The specified targets.</p>"
},
"TargetMaps":{
"shape":"TargetMaps",
"documentation":"<p>The specified key-value mapping of document parameters to target resources.</p>"
},
"ResolvedTargets":{
"shape":"ResolvedTargets",
"documentation":"<p>A list of resolved targets in the rate control execution.</p>"
@ -2505,6 +2526,10 @@
"shape":"Targets",
"documentation":"<p>The targets defined by the user when starting the Automation.</p>"
},
"TargetMaps":{
"shape":"TargetMaps",
"documentation":"<p>The specified key-value mapping of document parameters to target resources.</p>"
},
"ResolvedTargets":{
"shape":"ResolvedTargets",
"documentation":"<p>A list of targets that resolved during the execution.</p>"
@ -6643,7 +6668,8 @@
"Message":{"shape":"String"}
},
"documentation":"<p>An error occurred on the server side.</p>",
"exception":true
"exception":true,
"fault":true
},
"InvalidActivation":{
"type":"structure",
@ -7394,6 +7420,37 @@
"type":"list",
"member":{"shape":"TagKey"}
},
"LabelParameterVersionRequest":{
"type":"structure",
"required":[
"Name",
"Labels"
],
"members":{
"Name":{
"shape":"PSParameterName",
"documentation":"<p>The parameter name on which you want to attach one or more labels.</p>"
},
"ParameterVersion":{
"shape":"PSParameterVersion",
"documentation":"<p>The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.)</p>",
"box":true
},
"Labels":{
"shape":"ParameterLabelList",
"documentation":"<p>One or more labels to attach to the specified parameter version.</p>"
}
}
},
"LabelParameterVersionResult":{
"type":"structure",
"members":{
"InvalidLabels":{
"shape":"ParameterLabelList",
"documentation":"<p>The label does not meet the requirements. For information about parameter label requirements, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-labels.html\">Labeling Parameters</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
}
}
},
"LastResourceDataSyncMessage":{"type":"string"},
"LastResourceDataSyncStatus":{
"type":"string",
@ -8620,6 +8677,11 @@
"max":2048,
"min":1
},
"PSParameterSelector":{
"type":"string",
"max":128,
"min":0
},
"PSParameterValue":{
"type":"string",
"max":4096,
@ -8644,6 +8706,22 @@
"Version":{
"shape":"PSParameterVersion",
"documentation":"<p>The parameter version.</p>"
},
"Selector":{
"shape":"PSParameterSelector",
"documentation":"<p>Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:</p> <p>parameter_name:version</p> <p>parameter_name:label</p>"
},
"SourceResult":{
"shape":"String",
"documentation":"<p>Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.</p>"
},
"LastModifiedDate":{
"shape":"DateTime",
"documentation":"<p>Date the parameter was last changed or updated and the parameter version was created.</p>"
},
"ARN":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the parameter.</p>"
}
},
"documentation":"<p>An Amazon EC2 Systems Manager parameter in Parameter Store.</p>"
@ -8699,6 +8777,10 @@
"Version":{
"shape":"PSParameterVersion",
"documentation":"<p>The parameter version.</p>"
},
"Labels":{
"shape":"ParameterLabelList",
"documentation":"<p>Labels assigned to the parameter version.</p>"
}
},
"documentation":"<p>Information about parameter usage.</p>"
@ -8713,6 +8795,17 @@
"min":1,
"pattern":"^([a-zA-Z0-9:/_-]+)$"
},
"ParameterLabel":{
"type":"string",
"max":100,
"min":1
},
"ParameterLabelList":{
"type":"list",
"member":{"shape":"ParameterLabel"},
"max":10,
"min":1
},
"ParameterLimitExceeded":{
"type":"structure",
"members":{
@ -8824,7 +8917,7 @@
"type":"string",
"max":132,
"min":1,
"pattern":"tag:.+|Name|Type|KeyId|Path"
"pattern":"tag:.+|Name|Type|KeyId|Path|Label"
},
"ParameterStringFilterList":{
"type":"list",
@ -8859,6 +8952,14 @@
"type":"list",
"member":{"shape":"ParameterValue"}
},
"ParameterVersionLabelLimitExceeded":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>A parameter version can have a maximum of ten labels.</p>",
"exception":true
},
"ParameterVersionNotFound":{
"type":"structure",
"members":{
@ -9594,7 +9695,6 @@
"WindowId",
"Targets",
"TaskArn",
"ServiceRoleArn",
"TaskType",
"MaxConcurrency",
"MaxErrors"
@ -9614,7 +9714,7 @@
},
"ServiceRoleArn":{
"shape":"ServiceRole",
"documentation":"<p>The role that should be assumed when executing the task.</p>"
"documentation":"<p>The role to assume when running the Maintenance Window task.</p> <p>If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run <code>RegisterTaskWithMaintenanceWindow</code> without specifying a service role ARN.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions\">Service-Linked Role Permissions for Systems Manager</a> and <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role\">Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? </a> in the <i>AWS Systems Manager User Guide</i>.</p>"
},
"TaskType":{
"shape":"MaintenanceWindowTaskType",
@ -10211,6 +10311,10 @@
"shape":"Targets",
"documentation":"<p>A key-value mapping to target resources. Required if you specify TargetParameterName.</p>"
},
"TargetMaps":{
"shape":"TargetMaps",
"documentation":"<p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.</p>"
},
"MaxConcurrency":{
"shape":"MaxConcurrency",
"documentation":"<p>The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.</p>"
@ -10320,6 +10424,25 @@
"OverriddenParameters":{
"shape":"AutomationParameterMap",
"documentation":"<p>A user-specified list of parameters to override when executing a step.</p>"
},
"IsEnd":{
"shape":"Boolean",
"documentation":"<p>The flag which can be used to end automation no matter whether the step succeeds or fails.</p>",
"box":true
},
"NextStep":{
"shape":"String",
"documentation":"<p>The next step after the step succeeds.</p>",
"box":true
},
"IsCritical":{
"shape":"Boolean",
"documentation":"<p>The flag which can be used to help decide whether the failure of current step leads to the Automation failure.</p>",
"box":true
},
"ValidNextSteps":{
"shape":"ValidNextStepList",
"documentation":"<p>Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to execute the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.</p>"
}
},
"documentation":"<p>Detailed information about an the execution state of an Automation step.</p>"
@ -10480,6 +10603,35 @@
"min":1,
"pattern":"^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$"
},
"TargetMap":{
"type":"map",
"key":{"shape":"TargetMapKey"},
"value":{"shape":"TargetMapValueList"},
"max":20,
"min":1
},
"TargetMapKey":{
"type":"string",
"max":50,
"min":1
},
"TargetMapValue":{
"type":"string",
"max":50,
"min":1
},
"TargetMapValueList":{
"type":"list",
"member":{"shape":"TargetMapValue"},
"max":25,
"min":0
},
"TargetMaps":{
"type":"list",
"member":{"shape":"TargetMap"},
"max":300,
"min":0
},
"TargetParameterList":{
"type":"list",
"member":{"shape":"ParameterValue"}
@ -10894,7 +11046,7 @@
},
"ServiceRoleArn":{
"shape":"ServiceRole",
"documentation":"<p>The IAM service role ARN to modify. The system assumes this role during task execution. </p>"
"documentation":"<p>The IAM service role ARN to modify. The system assumes this role during task execution.</p> <p>If you do not specify a service role ARN, Systems Manager will use your account's service-linked role for Systems Manager by default. If no service-linked role for Systems Manager exists in your account, it will be created when you run <code>RegisterTaskWithMaintenanceWindow</code> without specifying a service role ARN.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/using-service-linked-roles.html#slr-permissions\">Service-Linked Role Permissions for Systems Manager</a> and <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html#maintenance-window-tasks-service-role\">Should I Use a Service-Linked Role or a Custom Service Role to Run Maintenance Window Tasks? </a> in the <i>AWS Systems Manager User Guide</i>.</p>"
},
"TaskParameters":{
"shape":"MaintenanceWindowTaskParameters",
@ -11126,6 +11278,15 @@
}
},
"Url":{"type":"string"},
"ValidNextStep":{
"type":"string",
"max":65535,
"min":1
},
"ValidNextStepList":{
"type":"list",
"member":{"shape":"ValidNextStep"}
},
"Version":{
"type":"string",
"pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$"

153
botocore/data/storagegateway/2013-06-30/service-2.json
View file

@ -136,7 +136,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>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 in the file gateway type.</p> <important> <p>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 region you are creating your file gateway in. If AWS STS is not activated in the 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. </p> <p>File gateway does not support creating hard or symbolic links on a file share.</p> </important>"
"documentation":"<p>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.</p> <important> <p>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 region you are creating your file gateway in. If AWS STS is not activated in the 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. </p> <p>File gateway does not support creating hard or symbolic links on a file share.</p> </important>"
},
"CreateSMBFileShare":{
"name":"CreateSMBFileShare",
@ -150,7 +150,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>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 in the file gateway type.</p> <important> <p>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 region you are creating your file gateway in. If AWS STS is not activated in the 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. </p> <p>File gateway does not support creating hard or symbolic links on a file share.</p> </important>"
"documentation":"<p>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.</p> <important> <p>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 <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html\">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>AWS Identity and Access Management User Guide.</i> </p> <p>File gateways don't support creating hard or symbolic links on a file share.</p> </important>"
},
"CreateSnapshot":{
"name":"CreateSnapshot",
@ -264,7 +264,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes a file share from a file gateway. This operation is only supported in the file gateway type.</p>"
"documentation":"<p>Deletes a file share from a file gateway. This operation is only supported for file gateways.</p>"
},
"DeleteGateway":{
"name":"DeleteGateway",
@ -432,7 +432,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported in the file gateway type.</p>"
"documentation":"<p>Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.</p>"
},
"DescribeSMBFileShares":{
"name":"DescribeSMBFileShares",
@ -446,7 +446,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported in the file gateway type.</p>"
"documentation":"<p>Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.</p>"
},
"DescribeSMBSettings":{
"name":"DescribeSMBSettings",
@ -460,7 +460,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported in the file gateway type.</p>"
"documentation":"<p>Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.</p>"
},
"DescribeSnapshotSchedule":{
"name":"DescribeSnapshotSchedule",
@ -600,7 +600,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Adds a file gateway to an Active Directory domain. This operation is only supported in the file gateway type that supports the SMB file protocol.</p>"
"documentation":"<p>Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.</p>"
},
"ListFileShares":{
"name":"ListFileShares",
@ -614,7 +614,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported in the file gateway type.</p>"
"documentation":"<p>Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.</p>"
},
"ListGateways":{
"name":"ListGateways",
@ -726,7 +726,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3.</p> <p>AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported in the file gateway type.</p> <p>For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification). </p>"
"documentation":"<p>Sends you notification through CloudWatch Events when all files written to your NFS file share have been uploaded to Amazon S3.</p> <p>AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the NFS file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways.</p> <p>For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification). </p>"
},
"RefreshCache":{
"name":"RefreshCache",
@ -824,7 +824,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Sets the password for the guest user “smbguest”. \"smbguest\" is the user when the Authentication method for the file share is “GuestAccess”.</p>"
"documentation":"<p>Sets the password for the guest user <code>smbguest</code>. The <code>smbguest</code> user is the user when the authentication method for the file share is set to <code>GuestAccess</code>.</p>"
},
"ShutdownGateway":{
"name":"ShutdownGateway",
@ -950,7 +950,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates a Server Message Block (SMB) file share. This operation is only supported in the file gateway type.</p> <note> <p>To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in the file gateway type.</p> </note> <important> <p>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 region you are creating your file gateway in. If AWS STS is not activated in the 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. </p> <p>File gateway does not support creating hard or symbolic links on a file share.</p> </important>"
"documentation":"<p>Updates a Server Message Block (SMB) file share.</p> <note> <p>To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.</p> </note> <important> <p>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 <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html\">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>AWS Identity and Access Management User Guide.</i> </p> <p>File gateways don't support creating hard or symbolic links on a file share.</p> </important>"
},
"UpdateSnapshotSchedule":{
"name":"UpdateSnapshotSchedule",
@ -1120,7 +1120,7 @@
},
"Authentication":{
"type":"string",
"documentation":"<p>The authentication method of the file share. Valid values: \"ActiveDirectory\" or \"GuestAccess\". The default is \"ActiveDirectory\".</p>",
"documentation":"<p>The authentication method of the file share.</p> <p>Valid values are <code>ActiveDirectory</code> or <code>GuestAccess</code>. The default is <code>ActiveDirectory</code>.</p>",
"max":15,
"min":5
},
@ -1316,7 +1316,7 @@
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
}
}
},
@ -1360,7 +1360,7 @@
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</p>"
"documentation":"<p>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.</p>"
},
"Role":{
"shape":"Role",
@ -1372,11 +1372,11 @@
},
"DefaultStorageClass":{
"shape":"StorageClass",
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.</p>"
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</p>"
},
"ObjectACL":{
"shape":"ObjectACL",
"documentation":"<p>Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
},
"ClientList":{
"shape":"FileShareClientList",
@ -1384,19 +1384,19 @@
},
"Squash":{
"shape":"Squash",
"documentation":"<p>Maps a user to anonymous user. Valid options are the following: </p> <ul> <li> <p>\"RootSquash\" - Only root is mapped to anonymous user.</p> </li> <li> <p>\"NoSquash\" - No one is mapped to anonymous user.</p> </li> <li> <p>\"AllSquash\" - Everyone is mapped to anonymous user.</p> </li> </ul>"
"documentation":"<p>Maps a user to anonymous user. Valid options are the following: </p> <ul> <li> <p> <code>RootSquash</code> - Only root is mapped to anonymous user.</p> </li> <li> <p> <code>NoSquash</code> - No one is mapped to anonymous user</p> </li> <li> <p> <code>AllSquash</code> - Everyone is mapped to anonymous user.</p> </li> </ul>"
},
"ReadOnly":{
"shape":"Boolean",
"documentation":"<p>Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
"documentation":"<p>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
},
"GuessMIMETypeEnabled":{
"shape":"Boolean",
"documentation":"<p>Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
"documentation":"<p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
},
"RequesterPays":{
"shape":"Boolean",
"documentation":"<p>Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is <code>private</code>.</p>"
}
},
"documentation":"<p>CreateNFSFileShareInput</p>"
@ -1434,7 +1434,7 @@
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</p>"
"documentation":"<p>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.</p>"
},
"Role":{
"shape":"Role",
@ -1446,35 +1446,35 @@
},
"DefaultStorageClass":{
"shape":"StorageClass",
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.</p>"
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</p>"
},
"ObjectACL":{
"shape":"ObjectACL",
"documentation":"<p>Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
},
"ReadOnly":{
"shape":"Boolean",
"documentation":"<p>Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
"documentation":"<p>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
},
"GuessMIMETypeEnabled":{
"shape":"Boolean",
"documentation":"<p>Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
"documentation":"<p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
},
"RequesterPays":{
"shape":"Boolean",
"documentation":"<p>Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is <code>private</code>.</p>"
},
"ValidUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to \"ActiveDirectory\".</p>"
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
},
"InvalidUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to \"ActiveDirectory\".</p>"
"documentation":"<p>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 <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
},
"Authentication":{
"shape":"Authentication",
"documentation":"<p>The authentication method that users use to access the file share.</p> <p>Valid values: \"ActiveDirectory\" or \"GuestAccess\". The default is \"ActiveDirectory\".</p>"
"documentation":"<p>The authentication method that users use to access the file share.</p> <p>Valid values are <code>ActiveDirectory</code> or <code>GuestAccess</code>. The default is <code>ActiveDirectory</code>.</p>"
}
},
"documentation":"<p>CreateSMBFileShareInput</p>"
@ -1570,6 +1570,14 @@
"NetworkInterfaceId":{
"shape":"NetworkInterfaceId",
"documentation":"<p>The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use <a>DescribeGatewayInformation</a> to get a list of the network interfaces available on a gateway.</p> <p> Valid Values: A valid IP address.</p>"
},
"KMSEncrypted":{
"shape":"Boolean",
"documentation":"<p>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.</p>"
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>A JSON object containing one or more of the following fields:</p> <ul> <li> <p> <a>CreateStorediSCSIVolumeInput$DiskId</a> </p> </li> <li> <p> <a>CreateStorediSCSIVolumeInput$NetworkInterfaceId</a> </p> </li> <li> <p> <a>CreateStorediSCSIVolumeInput$PreserveExistingData</a> </p> </li> <li> <p> <a>CreateStorediSCSIVolumeInput$SnapshotId</a> </p> </li> <li> <p> <a>CreateStorediSCSIVolumeInput$TargetName</a> </p> </li> </ul>"
@ -1618,7 +1626,7 @@
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>CreateTapeWithBarcodeInput</p>"
@ -1669,7 +1677,7 @@
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>CreateTapesInput</p>"
@ -2146,7 +2154,7 @@
"members":{
"TapeArchives":{
"shape":"TapeArchives",
"documentation":"<p>An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.</p>"
"documentation":"<p>An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.</p>"
},
"Marker":{
"shape":"Marker",
@ -2313,7 +2321,7 @@
"members":{
"TargetARN":{
"shape":"TargetARN",
"documentation":"<p>Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.</p>"
"documentation":"<p>Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.</p>"
},
"NetworkInterfaceId":{
"shape":"NetworkInterfaceId",
@ -2343,7 +2351,7 @@
"members":{
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The unique Amazon Resource Name of the disabled gateway.</p>"
"documentation":"<p>The unique Amazon Resource Name (ARN) of the disabled gateway.</p>"
}
},
"documentation":"<p>DisableGatewayOutput</p>"
@ -2660,7 +2668,7 @@
"members":{
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The unique Amazon Resource Name of the file gateway you want to add to the Active Directory domain. </p>"
"documentation":"<p>The unique Amazon Resource Name (ARN) of the file gateway you want to add to the Active Directory domain. </p>"
},
"DomainName":{
"shape":"DomainName",
@ -2682,14 +2690,14 @@
"members":{
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The unique Amazon Resource Name of the gateway that joined the domain.</p>"
"documentation":"<p>The unique Amazon Resource Name (ARN) of the gateway that joined the domain.</p>"
}
},
"documentation":"<p>JoinDomainOutput</p>"
},
"KMSKey":{
"type":"string",
"documentation":"<p>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.</p>",
"documentation":"<p>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.</p>",
"max":2048,
"min":20
},
@ -2939,7 +2947,7 @@
"documentation":"<p>The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody. </p>"
}
},
"documentation":"<p>Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported in the file gateway type.</p>"
"documentation":"<p>Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for file gateways.</p>"
},
"NFSFileShareInfo":{
"type":"structure",
@ -2951,7 +2959,7 @@
"GatewayARN":{"shape":"GatewayARN"},
"KMSEncrypted":{
"shape":"boolean",
"documentation":"<p>True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional. </p>"
"documentation":"<p>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. </p>"
},
"KMSKey":{"shape":"KMSKey"},
"Path":{"shape":"Path"},
@ -2959,22 +2967,22 @@
"LocationARN":{"shape":"LocationARN"},
"DefaultStorageClass":{
"shape":"StorageClass",
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.</p>"
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</p>"
},
"ObjectACL":{"shape":"ObjectACL"},
"ClientList":{"shape":"FileShareClientList"},
"Squash":{"shape":"Squash"},
"ReadOnly":{
"shape":"Boolean",
"documentation":"<p>Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
"documentation":"<p>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
},
"GuessMIMETypeEnabled":{
"shape":"Boolean",
"documentation":"<p>Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
"documentation":"<p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
},
"RequesterPays":{
"shape":"Boolean",
"documentation":"<p>Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is <code>private</code>.</p>"
}
},
"documentation":"<p>The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.</p>"
@ -3037,7 +3045,7 @@
},
"ObjectACL":{
"type":"string",
"documentation":"<p>Sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>",
"documentation":"<p>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>",
"enum":[
"private",
"public-read",
@ -3204,7 +3212,7 @@
"GatewayARN":{"shape":"GatewayARN"},
"KMSEncrypted":{
"shape":"boolean",
"documentation":"<p>True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional. </p>"
"documentation":"<p>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. </p>"
},
"KMSKey":{"shape":"KMSKey"},
"Path":{
@ -3215,32 +3223,32 @@
"LocationARN":{"shape":"LocationARN"},
"DefaultStorageClass":{
"shape":"StorageClass",
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.</p>"
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</p>"
},
"ObjectACL":{"shape":"ObjectACL"},
"ReadOnly":{
"shape":"Boolean",
"documentation":"<p>Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
"documentation":"<p>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
},
"GuessMIMETypeEnabled":{
"shape":"Boolean",
"documentation":"<p>Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
"documentation":"<p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
},
"RequesterPays":{
"shape":"Boolean",
"documentation":"<p>Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is <code>private</code>.</p>"
},
"ValidUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to \"ActiveDirectory\".</p>"
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
},
"InvalidUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to \"ActiveDirectory\".</p>"
"documentation":"<p>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 <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
},
"Authentication":{"shape":"Authentication"}
},
"documentation":"<p>The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.</p>"
"documentation":"<p>The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported for file gateways.</p>"
},
"SMBFileShareInfoList":{
"type":"list",
@ -3302,7 +3310,7 @@
},
"Password":{
"shape":"SMBGuestPassword",
"documentation":"<p>The password you want to set for your SMB Server.</p>"
"documentation":"<p>The password that you want to set for your SMB Server.</p>"
}
},
"documentation":"<p>SetSMBGuestPasswordInput</p>"
@ -3339,7 +3347,7 @@
},
"Squash":{
"type":"string",
"documentation":"<p>The user mapped to anonymous user. Valid options are the following: </p> <ul> <li> <p>\"RootSquash\" - Only root is mapped to anonymous user.</p> </li> <li> <p>\"NoSquash\" - No one is mapped to anonymous user</p> </li> <li> <p>\"AllSquash\" - Everyone is mapped to anonymous user.</p> </li> </ul>",
"documentation":"<p>The user mapped to anonymous user. Valid options are the following: </p> <ul> <li> <p> <code>RootSquash</code> - Only root is mapped to anonymous user.</p> </li> <li> <p> <code>NoSquash</code> - No one is mapped to anonymous user</p> </li> <li> <p> <code>AllSquash</code> - Everyone is mapped to anonymous user.</p> </li> </ul>",
"max":15,
"min":5
},
@ -3428,7 +3436,8 @@
"VolumeUsedInBytes":{
"shape":"VolumeUsedInBytes",
"documentation":"<p>The size of the data stored on the volume in bytes. </p> <note> <p>This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.</p> </note>"
}
},
"KMSKey":{"shape":"KMSKey"}
},
"documentation":"<p>Describes an iSCSI stored volume.</p>"
},
@ -3792,7 +3801,7 @@
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>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. </p>"
"documentation":"<p>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. </p>"
},
"NFSFileShareDefaults":{
"shape":"NFSFileShareDefaults",
@ -3800,11 +3809,11 @@
},
"DefaultStorageClass":{
"shape":"StorageClass",
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by a file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.</p>"
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</p>"
},
"ObjectACL":{
"shape":"ObjectACL",
"documentation":"<p>Sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
},
"ClientList":{
"shape":"FileShareClientList",
@ -3812,19 +3821,19 @@
},
"Squash":{
"shape":"Squash",
"documentation":"<p>The user mapped to anonymous user. Valid options are the following:</p> <ul> <li> <p>\"RootSquash\" - Only root is mapped to anonymous user.</p> </li> <li> <p>\"NoSquash\" - No one is mapped to anonymous user</p> </li> <li> <p>\"AllSquash\" - Everyone is mapped to anonymous user.</p> </li> </ul>"
"documentation":"<p>The user mapped to anonymous user. Valid options are the following:</p> <ul> <li> <p> <code>RootSquash</code> - Only root is mapped to anonymous user.</p> </li> <li> <p> <code>NoSquash</code> - No one is mapped to anonymous user</p> </li> <li> <p> <code>AllSquash</code> - Everyone is mapped to anonymous user.</p> </li> </ul>"
},
"ReadOnly":{
"shape":"Boolean",
"documentation":"<p>Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
"documentation":"<p>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
},
"GuessMIMETypeEnabled":{
"shape":"Boolean",
"documentation":"<p>Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
"documentation":"<p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
},
"RequesterPays":{
"shape":"Boolean",
"documentation":"<p>Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is <code>private</code>.</p>"
}
},
"documentation":"<p>UpdateNFSFileShareInput</p>"
@ -3845,7 +3854,7 @@
"members":{
"FileShareARN":{
"shape":"FileShareARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the SMB file share you want to update.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the SMB file share that you want to update.</p>"
},
"KMSEncrypted":{
"shape":"Boolean",
@ -3853,35 +3862,35 @@
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.</p>"
"documentation":"<p>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.</p>"
},
"DefaultStorageClass":{
"shape":"StorageClass",
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.</p>"
"documentation":"<p>The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are <code>S3_STANDARD</code>, <code>S3_STANDARD_IA</code>, or <code>S3_ONEZONE_IA</code>. If this field is not populated, the default value <code>S3_STANDARD</code> is used. Optional.</p>"
},
"ObjectACL":{
"shape":"ObjectACL",
"documentation":"<p>Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".</p>"
},
"ReadOnly":{
"shape":"Boolean",
"documentation":"<p>Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
"documentation":"<p>A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.</p>"
},
"GuessMIMETypeEnabled":{
"shape":"Boolean",
"documentation":"<p>Enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
"documentation":"<p>A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.</p>"
},
"RequesterPays":{
"shape":"Boolean",
"documentation":"<p>Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.</p>"
"documentation":"<p>A value that sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is <code>private</code>.</p>"
},
"ValidUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to \"ActiveDirectory\".</p>"
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
},
"InvalidUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to \"ActiveDirectory\".</p>"
"documentation":"<p>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 <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
}
},
"documentation":"<p>UpdateSMBFileShareInput</p>"
@ -4096,5 +4105,5 @@
"long":{"type":"long"},
"string":{"type":"string"}
},
"documentation":"<fullname>AWS Storage Gateway Service</fullname> <p>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 AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.</p> <p>Use the following links to get started using the <i>AWS Storage Gateway Service API Reference</i>:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders\">AWS Storage Gateway Required Request Headers</a>: Describes the required headers that you must send with every POST request to AWS Storage Gateway.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests\">Signing Requests</a>: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses\">Error Responses</a>: Provides reference information about AWS Storage Gateway errors.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html\">Operations in AWS Storage Gateway</a>: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">AWS Storage Gateway Regions and Endpoints:</a> Provides a list of each region and endpoints available for use with AWS Storage Gateway. </p> </li> </ul> <note> <p>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 <code>vol-AA22BB012345DAF670</code>. When you use this ID with the EC2 API, you must change it to <code>vol-aa22bb012345daf670</code>. Otherwise, the EC2 API might not behave as expected.</p> </note> <important> <p>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 <a href=\"https://aws.amazon.com/ec2/faqs/#longer-ids\">Longer EC2 and EBS Resource IDs</a>. </p> <p> For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:</p> <p> <code>arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG</code>.</p> <p>A snapshot ID with the longer ID format looks like the following: <code>snap-78e226633445566ee</code>.</p> <p>For more information, see <a href=\"https://forums.aws.amazon.com/ann.jspa?annID=3557\">Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016</a>.</p> </important>"
"documentation":"<fullname>AWS Storage Gateway Service</fullname> <p>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 AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.</p> <p>Use the following links to get started using the <i>AWS Storage Gateway Service API Reference</i>:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewayHTTPRequestsHeaders\">AWS Storage Gateway Required Request Headers</a>: Describes the required headers that you must send with every POST request to AWS Storage Gateway.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#AWSStorageGatewaySigningRequests\">Signing Requests</a>: AWS Storage Gateway requires that you authenticate every request you send; this topic describes how sign such a request.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/userguide/AWSStorageGatewayAPI.html#APIErrorResponses\">Error Responses</a>: Provides reference information about AWS Storage Gateway errors.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/storagegateway/latest/APIReference/API_Operations.html\">Operations in AWS Storage Gateway</a>: Contains detailed descriptions of all AWS Storage Gateway operations, their request parameters, response elements, possible errors, and examples of requests and responses.</p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">AWS Storage Gateway Regions and Endpoints:</a> Provides a list of each AWS region and endpoints available for use with AWS Storage Gateway. </p> </li> </ul> <note> <p>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 <code>vol-AA22BB012345DAF670</code>. When you use this ID with the EC2 API, you must change it to <code>vol-aa22bb012345daf670</code>. Otherwise, the EC2 API might not behave as expected.</p> </note> <important> <p>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 <a href=\"https://aws.amazon.com/ec2/faqs/#longer-ids\">Longer EC2 and EBS Resource IDs</a>. </p> <p> For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:</p> <p> <code>arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG</code>.</p> <p>A snapshot ID with the longer ID format looks like the following: <code>snap-78e226633445566ee</code>.</p> <p>For more information, see <a href=\"https://forums.aws.amazon.com/ann.jspa?annID=3557\">Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016</a>.</p> </important>"
}

6
botocore/data/transcribe/2017-10-26/service-2.json
View file

@ -450,11 +450,15 @@
},
"ShowSpeakerLabels":{
"shape":"Boolean",
"documentation":"<p>Determines whether the transcription job should use speaker recognition to identify different speakers in the input audio. If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the maximum number of speaker labels <code>MaxSpeakerLabels</code> field.</p>"
"documentation":"<p>Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the <code>ShowSpeakerLabels</code> field to true, you must also set the maximum number of speaker labels <code>MaxSpeakerLabels</code> field.</p> <p>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>"
},
"MaxSpeakerLabels":{
"shape":"MaxSpeakers",
"documentation":"<p>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 <code>MaxSpeakerLabels</code> field, you must set the <code>ShowSpeakerLabels</code> field to true.</p>"
},
"ChannelIdentification":{
"shape":"Boolean",
"documentation":"<p>Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription. </p> <p>Amazon Transcribe 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 the item including the confidence that Amazon Transcribe has in the transcription.</p> <p>You can't set both <code>ShowSpeakerLabels</code> and <code>ChannelIdentification</code> in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>"
}
},
"documentation":"<p>Provides optional settings for the <code>StartTranscriptionJob</code> operation.</p>"

7
botocore/handlers.py
View file

@ -844,6 +844,12 @@ class ClientMethodAlias(object):
def __call__(self, client, **kwargs):
return getattr(client, self._actual)
def remove_subscribe_to_shard(class_attributes, **kwargs):
if 'subscribe_to_shard' in class_attributes:
# subscribe_to_shard requires HTTP 2 support
del class_attributes['subscribe_to_shard']
# This is a list of (event_name, handler).
# When a Session is created, everything in this list will be
# automatically registered with that Session.
@ -856,6 +862,7 @@ BUILTIN_HANDLERS = [
convert_body_to_file_like_object, REGISTER_LAST),
('before-parameter-build.s3.PutObject',
convert_body_to_file_like_object, REGISTER_LAST),
('creating-client-class.kinesis', remove_subscribe_to_shard),
('creating-client-class', add_generate_presigned_url),
('creating-client-class.s3', add_generate_presigned_post),
('creating-client-class.rds', add_generate_db_auth_token),

43
botocore/hooks.py
View file

@ -343,6 +343,49 @@ class HierarchicalEmitter(BaseEventHooks):
return new_instance
class AliasedEventEmitter(HierarchicalEmitter):
EVENT_ALIASES = {
'api.sagemaker': 'sagemaker'
}
def __init__(self, event_aliases=None):
super(AliasedEventEmitter, self).__init__()
self._event_aliases = event_aliases
if event_aliases is None:
self._event_aliases = self.EVENT_ALIASES
def _emit(self, event_name, kwargs, stop_on_response=False):
aliased_event_name = self._alias_event_name(event_name)
return super(AliasedEventEmitter, self)._emit(
aliased_event_name, kwargs, stop_on_response
)
def _verify_and_register(self, event_name, handler, unique_id,
register_method, unique_id_uses_count):
aliased_event_name = self._alias_event_name(event_name)
super(AliasedEventEmitter, self)._verify_and_register(
aliased_event_name, handler, unique_id, register_method,
unique_id_uses_count
)
def unregister(self, event_name, handler=None, unique_id=None,
unique_id_uses_count=False):
aliased_event_name = self._alias_event_name(event_name)
super(AliasedEventEmitter, self).unregister(
aliased_event_name, handler, unique_id, unique_id_uses_count
)
def _alias_event_name(self, event_name):
for old_part, new_part in self._event_aliases.items():
if old_part in event_name:
new_name = event_name.replace(old_part, new_part)
logger.debug("Changing event name from %s to %s" % (
event_name, new_name
))
return new_name
return event_name
class _PrefixTrie(object):
"""Specialized prefix trie that handles wildcards.

5
botocore/model.py
View file

@ -50,7 +50,7 @@ class Shape(object):
'payload', 'streaming', 'timestampFormat',
'xmlNamespace', 'resultWrapper', 'xmlAttribute',
'eventstream', 'event', 'eventheader', 'eventpayload',
'jsonvalue']
'jsonvalue', 'timestampFormat']
METADATA_ATTRS = ['required', 'min', 'max', 'sensitive', 'enum',
'idempotencyToken', 'error', 'exception']
MAP_TYPE = OrderedDict
@ -106,6 +106,7 @@ class Shape(object):
* resultWrapper
* xmlAttribute
* jsonvalue
* timestampFormat
:rtype: dict
:return: Serialization information about the shape.
@ -316,7 +317,7 @@ class ServiceModel(object):
return self.metadata[name]
except KeyError:
raise UndefinedModelAttributeError(
'"%s" not defined in the metadata of the the model: %s' %
'"%s" not defined in the metadata of the model: %s' %
(name, self))
# Signature version is one of the rare properties

36
botocore/serialize.py
View file

@ -39,8 +39,9 @@ and if a str/unicode type is passed in, it will be encoded as utf-8.
"""
import re
import base64
from xml.etree import ElementTree
import calendar
import datetime
from xml.etree import ElementTree
from botocore.compat import six
@ -138,12 +139,17 @@ class Serializer(object):
return int(calendar.timegm(value.timetuple()))
def _timestamp_rfc822(self, value):
if isinstance(value, datetime.datetime):
value = self._timestamp_unixtimestamp(value)
return formatdate(value, usegmt=True)
def _convert_timestamp_to_str(self, value):
def _convert_timestamp_to_str(self, value, timestamp_format=None):
if timestamp_format is None:
timestamp_format = self.TIMESTAMP_FORMAT
timestamp_format = timestamp_format.lower()
datetime_obj = parse_to_aware_datetime(value)
converter = getattr(
self, '_timestamp_%s' % self.TIMESTAMP_FORMAT.lower())
self, '_timestamp_%s' % timestamp_format)
final_value = converter(datetime_obj)
return final_value
@ -245,7 +251,8 @@ class QuerySerializer(Serializer):
serialized[prefix] = self._get_base64(value)
def _serialize_type_timestamp(self, serialized, value, shape, prefix=''):
serialized[prefix] = self._convert_timestamp_to_str(value)
serialized[prefix] = self._convert_timestamp_to_str(
value, shape.serialization.get('timestampFormat'))
def _serialize_type_boolean(self, serialized, value, shape, prefix=''):
if value:
@ -304,7 +311,7 @@ class JSONSerializer(Serializer):
'X-Amz-Target': target,
'Content-Type': 'application/x-amz-json-%s' % json_version,
}
body = {}
body = self.MAP_TYPE()
input_shape = operation_model.input_shape
if input_shape is not None:
self._serialize(body, parameters, input_shape)
@ -355,7 +362,8 @@ class JSONSerializer(Serializer):
serialized[key] = value
def _serialize_type_timestamp(self, serialized, value, shape, key):
serialized[key] = self._convert_timestamp_to_str(value)
serialized[key] = self._convert_timestamp_to_str(
value, shape.serialization.get('timestampFormat'))
def _serialize_type_blob(self, serialized, value, shape, key):
serialized[key] = self._get_base64(value)
@ -371,6 +379,8 @@ class BaseRestSerializer(Serializer):
Subclasses must implement the ``_serialize_body_params`` method.
"""
QUERY_STRING_TIMESTAMP_FORMAT = 'iso8601'
HEADER_TIMESTAMP_FORMAT = 'rfc822'
# This is a list of known values for the "location" key in the
# serialization dict. The location key tells us where on the request
# to put the serialized value.
@ -486,6 +496,13 @@ class BaseRestSerializer(Serializer):
elif isinstance(param_value, bool):
partitioned['query_string_kwargs'][
key_name] = str(param_value).lower()
elif member.type_name == 'timestamp':
timestamp_format = member.serialization.get(
'timestampFormat', self.QUERY_STRING_TIMESTAMP_FORMAT)
partitioned['query_string_kwargs'][
key_name] = self._convert_timestamp_to_str(
param_value, timestamp_format
)
else:
partitioned['query_string_kwargs'][key_name] = param_value
elif location == 'header':
@ -518,7 +535,9 @@ class BaseRestSerializer(Serializer):
if shape.type_name == 'timestamp':
datetime_obj = parse_to_aware_datetime(value)
timestamp = calendar.timegm(datetime_obj.utctimetuple())
return self._timestamp_rfc822(timestamp)
timestamp_format = shape.serialization.get(
'timestampFormat', self.HEADER_TIMESTAMP_FORMAT)
return self._convert_timestamp_to_str(timestamp, timestamp_format)
elif is_json_value_header(shape):
# Serialize with no spaces after separators to save space in
# the header.
@ -623,7 +642,8 @@ class RestXMLSerializer(BaseRestSerializer):
def _serialize_type_timestamp(self, xmlnode, params, shape, name):
node = ElementTree.SubElement(xmlnode, name)
node.text = self._convert_timestamp_to_str(params)
node.text = self._convert_timestamp_to_str(
params, shape.serialization.get('timestampFormat'))
def _default_serialize(self, xmlnode, params, shape, name):
node = ElementTree.SubElement(xmlnode, name)

42
botocore/session.py
View file

@ -20,6 +20,7 @@ import copy
import logging
import os
import platform
import warnings
from botocore import __version__
import botocore.configloader
@ -29,7 +30,7 @@ from botocore.exceptions import ConfigNotFound, ProfileNotFound
from botocore.exceptions import UnknownServiceError, PartialCredentialsError
from botocore.errorfactory import ClientExceptionsFactory
from botocore import handlers
from botocore.hooks import HierarchicalEmitter, first_non_none_response
from botocore.hooks import AliasedEventEmitter, first_non_none_response
from botocore.loaders import create_loader
from botocore.parsers import ResponseParserFactory
from botocore.regions import EndpointResolver
@ -138,7 +139,7 @@ class Session(object):
if session_vars:
self.session_var_map.update(session_vars)
if event_hooks is None:
self._events = HierarchicalEmitter()
self._events = AliasedEventEmitter()
else:
self._events = event_hooks
if include_builtin_handlers:
@ -160,6 +161,7 @@ class Session(object):
self._session_instance_vars['profile'] = profile
self._client_config = None
self._components = ComponentLocator()
self._internal_components = ComponentLocator()
self._register_components()
def _register_components(self):
@ -188,7 +190,7 @@ class Session(object):
loader = self.get_component('data_loader')
endpoints = loader.load_data('endpoints')
return EndpointResolver(endpoints)
self._components.lazy_register_component(
self._internal_components.lazy_register_component(
'endpoint_resolver', create_default_resolver)
def _register_response_parser_factory(self):
@ -196,7 +198,7 @@ class Session(object):
ResponseParserFactory())
def _register_exceptions_factory(self):
self._components.register_component(
self._internal_components.register_component(
'exceptions_factory', ClientExceptionsFactory())
def _register_builtin_handlers(self, events):
@ -723,7 +725,29 @@ class Session(object):
return first_non_none_response(responses)
def get_component(self, name):
return self._components.get_component(name)
try:
return self._components.get_component(name)
except ValueError:
if name in ['endpoint_resolver', 'exceptions_factory']:
warnings.warn(
'Fetching the %s component with the get_component() '
'method is deprecated as the component has always been '
'considered an internal interface of botocore' % name,
DeprecationWarning)
return self._internal_components.get_component(name)
raise
def _get_internal_component(self, name):
# While this method may be called by botocore classes outside of the
# Session, this method should **never** be used by a class that lives
# outside of botocore.
return self._internal_components.get_component(name)
def _register_internal_component(self, name, component):
# While this method may be called by botocore classes outside of the
# Session, this method should **never** be used by a class that lives
# outside of botocore.
return self._internal_components.register_component(name, component)
def register_component(self, name, component):
self._components.register_component(name, component)
@ -848,8 +872,8 @@ class Session(object):
aws_secret_access_key))
else:
credentials = self.get_credentials()
endpoint_resolver = self.get_component('endpoint_resolver')
exceptions_factory = self.get_component('exceptions_factory')
endpoint_resolver = self._get_internal_component('endpoint_resolver')
exceptions_factory = self._get_internal_component('exceptions_factory')
client_creator = botocore.client.ClientCreator(
loader, endpoint_resolver, self.user_agent(), event_emitter,
retryhandler, translate, response_parser_factory,
@ -874,7 +898,7 @@ class Session(object):
:rtype: list
:return: Returns a list of partition names (e.g., ["aws", "aws-cn"])
"""
resolver = self.get_component('endpoint_resolver')
resolver = self._get_internal_component('endpoint_resolver')
return resolver.get_available_partitions()
def get_available_regions(self, service_name, partition_name='aws',
@ -897,7 +921,7 @@ class Session(object):
fips-us-gov-west-1, etc).
:return: Returns a list of endpoint names (e.g., ["us-east-1"]).
"""
resolver = self.get_component('endpoint_resolver')
resolver = self._get_internal_component('endpoint_resolver')
results = []
try:
service_data = self.get_service_data(service_name)

12
botocore/utils.py
View file

@ -333,7 +333,7 @@ def percent_encode(input_str, safe=SAFE_CHARS):
If given the binary type, will simply URL encode it. If given the
text type, will produce the binary type by UTF-8 encoding the
text. If given something else, will convert it to the the text type
text. If given something else, will convert it to the text type
first.
"""
# If its not a binary or text string, make it a text string.
@ -911,6 +911,7 @@ class S3RegionRedirector(object):
error = response[1].get('Error', {})
error_code = error.get('Code')
response_metadata = response[1].get('ResponseMetadata', {})
# We have to account for 400 responses because
# if we sign a Head* request with the wrong region,
@ -918,7 +919,12 @@ class S3RegionRedirector(object):
# body saying it's an "AuthorizationHeaderMalformed".
is_special_head_object = (
error_code in ['301', '400'] and
operation.name in ['HeadObject', 'HeadBucket']
operation.name == 'HeadObject'
)
is_special_head_bucket = (
error_code in ['301', '400'] and
operation.name == 'HeadBucket' and
'x-amz-bucket-region' in response_metadata.get('HTTPHeaders', {})
)
is_wrong_signing_region = (
error_code == 'AuthorizationHeaderMalformed' and
@ -926,7 +932,7 @@ class S3RegionRedirector(object):
)
is_permanent_redirect = error_code == 'PermanentRedirect'
if not any([is_special_head_object, is_wrong_signing_region,
is_permanent_redirect]):
is_permanent_redirect, is_special_head_bucket]):
return
bucket = request_dict['context']['signing']['bucket']

2
docs/source/conf.py
View file

@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat'
# The short X.Y version.
version = '1.10.'
# The full version, including alpha/beta/rc tags.
release = '1.10.55'
release = '1.10.78'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

2
docs/source/topics/paginators.rst
View file

@ -109,7 +109,7 @@ JMESPath expressions that are applied to each page of results through the
When filtering with JMESPath expressions, each page of results that is yielded
by the paginator is mapped through the JMESPath expression. If a JMESPath
expression returns a single value that is not an array, that value is yielded
directly. If the the result of applying the JMESPath expression to a page of
directly. If the result of applying the JMESPath expression to a page of
results is a list, then each value of the list is yielded individually
(essentially implementing a flat map). For example, in the above expression,
each key that has a ``Size`` greater than `100` is yielded by the

1
setup.py
View file

@ -78,5 +78,6 @@ setup(
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
),
)

2
tests/functional/test_endpoints.py
View file

@ -136,8 +136,6 @@ def test_service_name_matches_endpoint_prefix():
# named based on the service id matches the service name used to
# create a client (i.e the directory name in botocore/data)
# unless there is an explicit exception.
# If there model has no serviceId then we fall back to the endpoint
# prefix.
session = get_session()
loader = session.get_component('data_loader')

50
tests/functional/test_h2_required.py Normal file
View file

@ -0,0 +1,50 @@
# Copyright 2018 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.
from botocore.session import get_session
_H2_REQUIRED = object()
# Service names to list of known HTTP 2 operations
_KNOWN_SERVICES = {
'kinesis': ['SubscribeToShard'],
}
def test_all_uses_of_h2_are_known():
session = get_session()
loader = session.get_component('data_loader')
services = loader.list_available_services('service-2')
for service in services:
service_model = session.get_service_model(service)
h2_config = service_model.metadata.get('protocolSettings', {}).get('h2')
if h2_config == 'required':
yield _assert_h2_service_is_known, service
elif h2_config == 'eventstream':
for operation in service_model.operation_names:
operation_model = service_model.operation_model(operation)
if operation_model.has_event_stream_output:
yield _assert_h2_operation_is_known, service, operation
def _assert_h2_service_is_known(service):
# Validates that a service that requires HTTP 2 for all operations is known
message = 'Found unknown HTTP 2 service: %s' % service
assert _KNOWN_SERVICES.get(service) is _H2_REQUIRED, message
def _assert_h2_operation_is_known(service, operation):
# Validates that an operation that requires HTTP 2 is known
known_operations = _KNOWN_SERVICES.get(service, [])
message = 'Found unknown HTTP 2 operation: %s.%s' % (service, operation)
assert operation in known_operations, message

19
tests/functional/test_kinesis.py Normal file
View file

@ -0,0 +1,19 @@
# Copyright 2018 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.
from tests import BaseSessionTest
class TestKinesis(BaseSessionTest):
def test_subscribe_to_shard_removed(self):
kinesis = self.session.create_client('kinesis', 'us-west-2')
with self.assertRaises(AttributeError):
kinesis.subscribe_to_shard

11
tests/functional/test_regions.py
View file

@ -453,7 +453,8 @@ def test_known_endpoints():
# fixed list of known endpoints. This list doesn't need to be kept 100% up
# to date, but serves as a basis for regressions as the endpoint data
# logic evolves.
resolver = _get_patched_session().get_component('endpoint_resolver')
resolver = _get_patched_session()._get_internal_component(
'endpoint_resolver')
for region_name, service_dict in KNOWN_REGIONS.items():
for service_name, endpoint in service_dict.items():
yield (_test_single_service_region, service_name,
@ -472,7 +473,7 @@ def _test_single_service_region(service_name, region_name,
def test_all_s3_endpoints_have_s3v4():
session = _get_patched_session()
partitions = session.get_available_partitions()
resolver = session.get_component('endpoint_resolver')
resolver = session._get_internal_component('endpoint_resolver')
for partition_name in partitions:
for endpoint in session.get_available_regions('s3', partition_name):
resolved = resolver.construct_endpoint('s3', endpoint)
@ -481,7 +482,8 @@ def test_all_s3_endpoints_have_s3v4():
def test_known_endpoints():
resolver = _get_patched_session().get_component('endpoint_resolver')
resolver = _get_patched_session()._get_internal_component(
'endpoint_resolver')
for service_name, endpoint in KNOWN_AWS_PARTITION_WIDE.items():
yield (_test_single_service_partition_endpoint, service_name,
endpoint, resolver)
@ -495,5 +497,6 @@ def _test_single_service_partition_endpoint(service_name, expected_endpoint,
def test_non_partition_endpoint_requires_region():
resolver = _get_patched_session().get_component('endpoint_resolver')
resolver = _get_patched_session()._get_internal_component(
'endpoint_resolver')
assert_raises(NoRegionError, resolver.construct_endpoint, 'ec2')

41
tests/functional/test_sagemaker.py Normal file
View file

@ -0,0 +1,41 @@
from botocore.stub import Stubber
from tests import BaseSessionTest
class TestSagemaker(BaseSessionTest):
def setUp(self):
super(TestSagemaker, self).setUp()
self.region = 'us-west-2'
self.client = self.session.create_client(
'sagemaker', self.region)
self.stubber = Stubber(self.client)
self.stubber.activate()
self.hook_calls = []
def _hook(self, **kwargs):
self.hook_calls.append(kwargs['event_name'])
def tearDown(self):
self.stubber.deactivate()
def test_event_with_old_prefix(self):
self.client.meta.events.register(
'provide-client-params.sagemaker.ListEndpoints',
self._hook
)
self.stubber.add_response('list_endpoints', {'Endpoints': []})
self.client.list_endpoints()
self.assertEqual(self.hook_calls, [
'provide-client-params.sagemaker.ListEndpoints'
])
def test_event_with_new_prefix(self):
self.client.meta.events.register(
'provide-client-params.api.sagemaker.ListEndpoints',
self._hook
)
self.stubber.add_response('list_endpoints', {'Endpoints': []})
self.client.list_endpoints()
self.assertEqual(self.hook_calls, [
'provide-client-params.sagemaker.ListEndpoints'
])

2
tests/integration/test_smoke.py
View file

@ -142,7 +142,7 @@ ERROR_TESTS = {
'cognito-identity': {'DescribeIdentityPool': {'IdentityPoolId': 'fake'}},
'cognito-sync': {'DescribeIdentityPoolUsage': {'IdentityPoolId': 'fake'}},
'config': {
'GetResourceConfigHistory': {'resourceType': '', 'resourceId': ''},
'GetResourceConfigHistory': {'resourceType': '', 'resourceId': 'fake'},
},
'datapipeline': {'GetPipelineDefinition': {'pipelineId': 'fake'}},
'devicefarm': {'GetDevice': {'arn': 'arn:aws:devicefarm:REGION::device:f'}},

21
tests/unit/protocols/input/ec2.json
View file

@ -243,7 +243,7 @@
"headers": {
"Content-Type": "application/x-www-form-urlencoded; charset=utf-8"
},
"body": "Action=OperationName&Version=2014-01-01&ListMemberName.1=a&ListMemberName.2=b&ListMemberName.3=c"
"body": "Action=OperationName&Version=2014-01-01&ListMemberName.1=a&ListMemberName.2=b&ListMemberName.3=c"
}
}
]
@ -353,9 +353,20 @@
"members": {
"TimeArg": {
"shape": "TimestampType"
},
"TimeCustom": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType"
},
"TimeFormat": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
@ -369,14 +380,16 @@
"name": "OperationName"
},
"params": {
"TimeArg": 1422172800
"TimeArg": 1422172800,
"TimeCustom": 1422172800,
"TimeFormat": 1422172800
},
"serialized": {
"uri": "/",
"headers": {
"Content-Type": "application/x-www-form-urlencoded; charset=utf-8"
},
"body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z"
"body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z&TimeCustom=1422172800&TimeFormat=1422172800"
}
}
]
@ -393,7 +406,7 @@
"members": {
"Token": {
"shape": "StringType",
"idempotencyToken": true
"idempotencyToken": true
}
}
},

33
tests/unit/protocols/input/json.json
View file

@ -57,9 +57,20 @@
"members": {
"TimeArg": {
"shape": "TimestampType"
},
"TimeCustom": {
"timestampFormat": "rfc822",
"shape": "TimestampType"
},
"TimeFormat": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "rfc822",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
@ -73,10 +84,12 @@
"name": "OperationName"
},
"params": {
"TimeArg": 1422172800
"TimeArg": 1422172800,
"TimeCustom": 1422172800,
"TimeFormat": 1422172800
},
"serialized": {
"body": "{\"TimeArg\": 1422172800}",
"body": "{\"TimeArg\": 1422172800, \"TimeCustom\": \"Sun, 25 Jan 2015 08:00:00 GMT\", \"TimeFormat\": \"Sun, 25 Jan 2015 08:00:00 GMT\"}",
"headers": {
"X-Amz-Target": "com.amazonaws.foo.OperationName",
"Content-Type": "application/x-amz-json-1.1"
@ -101,7 +114,7 @@
"shape": "BlobType"
},
"BlobMap": {
"shape": "BlobMapType"
"shape": "BlobMapType"
}
}
},
@ -146,8 +159,8 @@
},
"params": {
"BlobMap": {
"key1": "foo",
"key2": "bar"
"key1": "foo",
"key2": "bar"
}
},
"serialized": {
@ -180,7 +193,7 @@
"ListOfStructures": {
"type": "list",
"member": {
"shape": "BlobType"
"shape": "BlobType"
}
},
"BlobType": {
@ -204,8 +217,10 @@
"serialized": {
"body": "{\"ListParam\": [\"Zm9v\", \"YmFy\"]}",
"uri": "/",
"headers": {"X-Amz-Target": "com.amazonaws.foo.OperationName",
"Content-Type": "application/x-amz-json-1.1"}
"headers": {
"X-Amz-Target": "com.amazonaws.foo.OperationName",
"Content-Type": "application/x-amz-json-1.1"
}
}
}
]
@ -491,7 +506,7 @@
"members": {
"Token": {
"shape": "StringType",
"idempotencyToken": true
"idempotencyToken": true
}
}
},

19
tests/unit/protocols/input/query.json
View file

@ -607,9 +607,20 @@
"members": {
"TimeArg": {
"shape": "TimestampType"
},
"TimeCustom": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType"
},
"TimeFormat": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
@ -623,14 +634,16 @@
"name": "OperationName"
},
"params": {
"TimeArg": 1422172800
"TimeArg": 1422172800,
"TimeCustom": 1422172800,
"TimeFormat": 1422172800
},
"serialized": {
"uri": "/",
"headers": {
"Content-Type": "application/x-www-form-urlencoded; charset=utf-8"
},
"body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z"
"body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z&TimeCustom=1422172800&TimeFormat=1422172800"
}
}
]
@ -852,7 +865,7 @@
"members": {
"Token": {
"shape": "StringType",
"idempotencyToken": true
"idempotencyToken": true
}
}
},

84
tests/unit/protocols/input/rest-json.json
View file

@ -677,7 +677,7 @@
}
]
},
{
{
"description": "Blob payload",
"metadata": {
"protocol": "rest-json",
@ -1103,9 +1103,51 @@
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timearg"
},
"TimeArgInQuery": {
"shape": "TimestampType",
"location": "querystring",
"locationName": "TimeQuery"
},
"TimeCustom": {
"timestampFormat": "iso8601",
"shape": "TimestampType"
},
"TimeCustomInHeader": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timecustom-header"
},
"TimeCustomInQuery": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType",
"location": "querystring",
"locationName": "TimeCustomQuery"
},
"TimeFormat": {
"shape": "TimestampFormatRfcType"
},
"TimeFormatInHeader": {
"shape": "TimestampFormatUnixType",
"location": "header",
"locationName": "x-amz-timeformat-header"
},
"TimeFormatInQuery": {
"shape": "TimestampFormatUnixType",
"location": "querystring",
"locationName": "TimeFormatQuery"
}
}
},
"TimestampFormatRfcType": {
"timestampFormat": "rfc822",
"type": "timestamp"
},
"TimestampFormatUnixType": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
@ -1123,32 +1165,24 @@
"name": "OperationName"
},
"params": {
"TimeArg": 1422172800
"TimeArg": 1422172800,
"TimeArgInQuery": 1422172800,
"TimeArgInHeader": 1422172800,
"TimeCustom": 1422172800,
"TimeCustomInQuery": 1422172800,
"TimeCustomInHeader": 1422172800,
"TimeFormat": 1422172800,
"TimeFormatInQuery": 1422172800,
"TimeFormatInHeader": 1422172800
},
"serialized": {
"uri": "/path",
"headers": {},
"body": "{\"TimeArg\": 1422172800}"
}
},
{
"given": {
"input": {
"shape": "InputShape"
"uri": "/path?TimeQuery=2015-01-25T08%3A00%3A00Z&TimeCustomQuery=1422172800&TimeFormatQuery=1422172800",
"headers": {
"x-amz-timearg": "Sun, 25 Jan 2015 08:00:00 GMT",
"x-amz-timecustom-header": "1422172800",
"x-amz-timeformat-header": "1422172800"
},
"http": {
"method": "POST",
"requestUri": "/path"
},
"name": "OperationName"
},
"params": {
"TimeArgInHeader": 1422172800
},
"serialized": {
"uri": "/path",
"headers": {"x-amz-timearg": "Sun, 25 Jan 2015 08:00:00 GMT"},
"body": ""
"body": "{\"TimeArg\": 1422172800, \"TimeCustom\": \"2015-01-25T08:00:00Z\", \"TimeFormat\": \"Sun, 25 Jan 2015 08:00:00 GMT\"}"
}
}
]
@ -1251,7 +1285,7 @@
"members": {
"Token": {
"shape": "StringType",
"idempotencyToken": true
"idempotencyToken": true
}
}
},

160
tests/unit/protocols/input/rest-xml.json
View file

@ -599,7 +599,7 @@
]
},
{
"description": "Blob and timestamp shapes",
"description": "Blob shapes",
"metadata": {
"protocol": "rest-xml",
"apiVersion": "2014-01-01"
@ -616,17 +616,11 @@
"StructureShape": {
"type": "structure",
"members": {
"t": {
"shape": "TShape"
},
"b": {
"shape": "BShape"
}
}
},
"TShape": {
"type": "timestamp"
},
"BShape": {
"type": "blob"
}
@ -647,19 +641,122 @@
},
"params": {
"StructureParam": {
"t": 1422172800,
"b": "foo"
}
},
"serialized": {
"method": "POST",
"body": "<OperationRequest xmlns=\"https://foo/\"><StructureParam><t>2015-01-25T08:00:00Z</t><b>Zm9v</b></StructureParam></OperationRequest>",
"body": "<OperationRequest xmlns=\"https://foo/\"><StructureParam><b>Zm9v</b></StructureParam></OperationRequest>",
"uri": "/2014-01-01/hostedzone",
"headers": {}
}
}
]
},
{
"description": "Timestamp shapes",
"metadata": {
"protocol": "rest-xml",
"apiVersion": "2014-01-01"
},
"shapes": {
"InputShape": {
"type": "structure",
"members": {
"TimeArg": {
"shape": "TimestampType"
},
"TimeArgInHeader": {
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timearg"
},
"TimeArgInQuery": {
"shape": "TimestampType",
"location": "querystring",
"locationName": "TimeQuery"
},
"TimeCustom": {
"timestampFormat": "rfc822",
"shape": "TimestampType"
},
"TimeCustomInHeader": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timecustom-header"
},
"TimeCustomInQuery": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType",
"location": "querystring",
"locationName": "TimeCustomQuery"
},
"TimeFormat": {
"shape": "TimestampFormatRfcType"
},
"TimeFormatInHeader": {
"shape": "TimestampFormatUnixType",
"location": "header",
"locationName": "x-amz-timeformat-header"
},
"TimeFormatInQuery": {
"shape": "TimestampFormatUnixType",
"location": "querystring",
"locationName": "TimeFormatQuery"
}
}
},
"TimestampFormatRfcType": {
"timestampFormat": "rfc822",
"type": "timestamp"
},
"TimestampFormatUnixType": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
},
"cases": [
{
"given": {
"http": {
"method": "POST",
"requestUri": "/2014-01-01/hostedzone"
},
"input": {
"shape": "InputShape",
"locationName": "TimestampStructure",
"xmlNamespace": {"uri": "https://foo/"}
},
"name": "OperationName"
},
"params": {
"TimeArg": 1422172800,
"TimeArgInQuery": 1422172800,
"TimeArgInHeader": 1422172800,
"TimeCustom": 1422172800,
"TimeCustomInQuery": 1422172800,
"TimeCustomInHeader": 1422172800,
"TimeFormat": 1422172800,
"TimeFormatInQuery": 1422172800,
"TimeFormatInHeader": 1422172800
},
"serialized": {
"method": "POST",
"body": "<TimestampStructure xmlns=\"https://foo/\"><TimeArg>2015-01-25T08:00:00Z</TimeArg><TimeCustom>Sun, 25 Jan 2015 08:00:00 GMT</TimeCustom><TimeFormat>Sun, 25 Jan 2015 08:00:00 GMT</TimeFormat></TimestampStructure>",
"uri": "/2014-01-01/hostedzone?TimeQuery=2015-01-25T08%3A00%3A00Z&TimeCustomQuery=1422172800&TimeFormatQuery=1422172800",
"headers": {
"x-amz-timearg": "Sun, 25 Jan 2015 08:00:00 GMT",
"x-amz-timecustom-header": "1422172800",
"x-amz-timeformat-header": "1422172800"
}
}
}
]
},
{
"description": "Header maps",
"metadata": {
@ -1586,51 +1683,6 @@
}
]
},
{
"description": "Timestamp in header",
"metadata": {
"protocol": "rest-xml",
"apiVersion": "2014-01-01"
},
"shapes": {
"InputShape": {
"type": "structure",
"members": {
"TimeArgInHeader": {
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timearg"
}
}
},
"TimestampType": {
"type": "timestamp"
}
},
"cases": [
{
"given": {
"input": {
"shape": "InputShape"
},
"http": {
"method": "POST",
"requestUri": "/path"
},
"name": "OperationName"
},
"params": {
"TimeArgInHeader": 1422172800
},
"serialized": {
"method": "POST",
"body": "",
"uri": "/path",
"headers": {"x-amz-timearg": "Sun, 25 Jan 2015 08:00:00 GMT"}
}
}
]
},
{
"description": "Idempotency token auto fill",
"metadata": {

68
tests/unit/protocols/output/ec2.json
View file

@ -450,5 +450,73 @@
}
}
]
},
{
"description": "Timestamp members",
"metadata": {
"protocol": "ec2"
},
"shapes": {
"OutputShape": {
"type": "structure",
"members": {
"TimeArg": {
"shape": "TimestampType"
},
"TimeCustom": {
"timestampFormat": "rfc822",
"shape": "TimestampType"
},
"TimeFormat": {
"shape": "TimestampFormatType"
},
"StructMember": {
"shape": "TimeContainer"
}
}
},
"TimeContainer": {
"type": "structure",
"members": {
"foo": {
"shape": "TimestampType"
},
"bar": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
},
"cases": [
{
"given": {
"output": {
"shape": "OutputShape"
},
"name": "OperationName"
},
"result": {
"TimeArg": 1398796238,
"TimeCustom": 1398796238,
"TimeFormat": 1398796238,
"StructMember": {
"foo": 1398796238,
"bar": 1398796238
}
},
"response": {
"status_code": 200,
"headers": {},
"body": "<OperationNameResponse><StructMember><foo>2014-04-29T18:30:38+00:00</foo><bar>1398796238</bar></StructMember><TimeArg>2014-04-29T18:30:38+00:00</TimeArg><TimeCustom>Tue, 29 Apr 2014 18:30:38 GMT</TimeCustom><TimeFormat>1398796238</TimeFormat><RequestId>requestid</RequestId></OperationNameResponse>"
}
}
]
}
]

35
tests/unit/protocols/output/json.json
View file

@ -142,24 +142,38 @@
"OutputShape": {
"type": "structure",
"members": {
"TimeMember": {
"shape": "TimeType"
"TimeArg": {
"shape": "TimestampType"
},
"TimeCustom": {
"timestampFormat": "rfc822",
"shape": "TimestampType"
},
"TimeFormat": {
"shape": "TimestampFormatType"
},
"StructMember": {
"shape": "TimeContainer"
}
}
},
"TimeType": {
"type": "timestamp"
},
"TimeContainer": {
"type": "structure",
"members": {
"foo": {
"shape": "TimeType"
"shape": "TimestampType"
},
"bar": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "iso8601",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
},
"cases": [
@ -171,15 +185,18 @@
"name": "OperationName"
},
"result": {
"TimeMember": 1398796238,
"TimeArg": 1398796238,
"TimeCustom": 1398796238,
"TimeFormat": 1398796238,
"StructMember": {
"foo": 1398796238
"foo": 1398796238,
"bar": 1398796238
}
},
"response": {
"status_code": 200,
"headers": {},
"body": "{\"TimeMember\": 1398796238, \"StructMember\": {\"foo\": 1398796238}}"
"body": "{\"TimeArg\": 1398796238, \"TimeCustom\": \"Tue, 29 Apr 2014 18:30:38 GMT\", \"TimeFormat\": \"2014-04-29T18:30:38+00:00\", \"StructMember\": {\"foo\": 1398796238, \"bar\": \"2014-04-29T18:30:38+00:00\"}}"
}
}
]

68
tests/unit/protocols/output/query.json
View file

@ -772,5 +772,73 @@
}
}
]
},
{
"description": "Timestamp members",
"metadata": {
"protocol": "query"
},
"shapes": {
"OutputShape": {
"type": "structure",
"members": {
"TimeArg": {
"shape": "TimestampType"
},
"TimeCustom": {
"timestampFormat": "rfc822",
"shape": "TimestampType"
},
"TimeFormat": {
"shape": "TimestampFormatType"
},
"StructMember": {
"shape": "TimeContainer"
}
}
},
"TimeContainer": {
"type": "structure",
"members": {
"foo": {
"shape": "TimestampType"
},
"bar": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
},
"cases": [
{
"given": {
"output": {
"shape": "OutputShape"
},
"name": "OperationName"
},
"result": {
"TimeArg": 1398796238,
"TimeCustom": 1398796238,
"TimeFormat": 1398796238,
"StructMember": {
"foo": 1398796238,
"bar": 1398796238
}
},
"response": {
"status_code": 200,
"headers": {},
"body": "<OperationNameResponse><StructMember><foo>2014-04-29T18:30:38+00:00</foo><bar>1398796238</bar></StructMember><TimeArg>2014-04-29T18:30:38+00:00</TimeArg><TimeCustom>Tue, 29 Apr 2014 18:30:38 GMT</TimeCustom><TimeFormat>1398796238</TimeFormat><RequestId>requestid</RequestId></OperationNameResponse>"
}
}
]
}
]

60
tests/unit/protocols/output/rest-json.json
View file

@ -166,24 +166,54 @@
"OutputShape": {
"type": "structure",
"members": {
"TimeMember": {
"shape": "TimeType"
"TimeArg": {
"shape": "TimestampType"
},
"TimeArgInHeader": {
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timearg"
},
"TimeCustom": {
"timestampFormat": "rfc822",
"shape": "TimestampType"
},
"TimeCustomInHeader": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timecustom"
},
"TimeFormat": {
"shape": "TimestampFormatType"
},
"TimeFormatInHeader": {
"shape": "TimestampFormatType",
"location": "header",
"locationName": "x-amz-timeformat"
},
"StructMember": {
"shape": "TimeContainer"
}
}
},
"TimeType": {
"type": "timestamp"
},
"TimeContainer": {
"type": "structure",
"members": {
"foo": {
"shape": "TimeType"
"shape": "TimestampType"
},
"bar": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "iso8601",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
},
"cases": [
@ -195,15 +225,25 @@
"name": "OperationName"
},
"result": {
"TimeMember": 1398796238,
"TimeArg": 1398796238,
"TimeArgInHeader": 1398796238,
"TimeCustom": 1398796238,
"TimeCustomInHeader": 1398796238,
"TimeFormat": 1398796238,
"TimeFormatInHeader": 1398796238,
"StructMember": {
"foo": 1398796238
"foo": 1398796238,
"bar": 1398796238
}
},
"response": {
"status_code": 200,
"headers": {},
"body": "{\"TimeMember\": 1398796238, \"StructMember\": {\"foo\": 1398796238}}"
"headers": {
"x-amz-timearg": "Tue, 29 Apr 2014 18:30:38 GMT",
"x-amz-timecustom": "1398796238",
"x-amz-timeformat": "2014-04-29T18:30:38+00:00"
},
"body": "{\"TimeArg\": 1398796238, \"TimeCustom\": \"Tue, 29 Apr 2014 18:30:38 GMT\", \"TimeFormat\": \"2014-04-29T18:30:38+00:00\", \"StructMember\": {\"foo\": 1398796238, \"bar\": \"2014-04-29T18:30:38+00:00\"}}"
}
}
]

92
tests/unit/protocols/output/rest-xml.json
View file

@ -756,6 +756,96 @@
}
}
]
},
{
"description": "Timestamp members",
"metadata": {
"protocol": "rest-xml"
},
"shapes": {
"OutputShape": {
"type": "structure",
"members": {
"TimeArg": {
"shape": "TimestampType"
},
"TimeArgInHeader": {
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timearg"
},
"TimeCustom": {
"timestampFormat": "rfc822",
"shape": "TimestampType"
},
"TimeCustomInHeader": {
"timestampFormat": "unixTimestamp",
"shape": "TimestampType",
"location": "header",
"locationName": "x-amz-timecustom"
},
"TimeFormat": {
"shape": "TimestampFormatType"
},
"TimeFormatInHeader": {
"shape": "TimestampFormatType",
"location": "header",
"locationName": "x-amz-timeformat"
},
"StructMember": {
"shape": "TimeContainer"
}
}
},
"TimeContainer": {
"type": "structure",
"members": {
"foo": {
"shape": "TimestampType"
},
"bar": {
"shape": "TimestampFormatType"
}
}
},
"TimestampFormatType": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
},
"TimestampType": {
"type": "timestamp"
}
},
"cases": [
{
"given": {
"output": {
"shape": "OutputShape"
},
"name": "OperationName"
},
"result": {
"TimeArg": 1398796238,
"TimeArgInHeader": 1398796238,
"TimeCustom": 1398796238,
"TimeCustomInHeader": 1398796238,
"TimeFormat": 1398796238,
"TimeFormatInHeader": 1398796238,
"StructMember": {
"foo": 1398796238,
"bar": 1398796238
}
},
"response": {
"status_code": 200,
"headers": {
"x-amz-timearg": "Tue, 29 Apr 2014 18:30:38 GMT",
"x-amz-timecustom": "1398796238",
"x-amz-timeformat": "1398796238"
},
"body": "<OperationNameResponse><StructMember><foo>2014-04-29T18:30:38+00:00</foo><bar>1398796238</bar></StructMember><TimeArg>2014-04-29T18:30:38+00:00</TimeArg><TimeCustom>Tue, 29 Apr 2014 18:30:38 GMT</TimeCustom><TimeFormat>1398796238</TimeFormat><RequestId>requestid</RequestId></OperationNameResponse>"
}
}
]
}
]

20
tests/unit/test_configloader.py
View file

@ -67,6 +67,13 @@ class TestConfigLoader(BaseEnvVar):
with self.assertRaises(botocore.exceptions.ConfigParseError):
raw_config_parse(filename)
def test_config_parse_error_filesystem_encoding_none(self):
filename = path('aws_config_bad')
with mock.patch('sys.getfilesystemencoding') as encoding:
encoding.return_value = None
with self.assertRaises(botocore.exceptions.ConfigParseError):
raw_config_parse(filename)
def test_config(self):
loaded_config = raw_config_parse(path('aws_config'))
self.assertIn('default', loaded_config)
@ -118,6 +125,13 @@ class TestConfigLoader(BaseEnvVar):
with self.assertRaises(botocore.exceptions.ConfigParseError):
loaded_config = load_config(filename)
def test_nested_bad_config_filesystem_encoding_none(self):
filename = path('aws_config_nested_bad')
with mock.patch('sys.getfilesystemencoding') as encoding:
encoding.return_value = None
with self.assertRaises(botocore.exceptions.ConfigParseError):
loaded_config = load_config(filename)
def test_multi_file_load(self):
filenames = [path('aws_config_other'),
path('aws_config'),
@ -142,6 +156,12 @@ class TestConfigLoader(BaseEnvVar):
encoding.return_value = 'utf-8'
load_config(path(b'\xe2\x9c\x93'))
def test_unicode_bytes_path_not_found_filesystem_encoding_none(self):
with mock.patch('sys.getfilesystemencoding') as encoding:
encoding.return_value = None
with self.assertRaises(botocore.exceptions.ConfigNotFound):
load_config(path(b'\xe2\x9c\x93'))
def test_unicode_bytes_path(self):
filename = self.create_config_file(b'aws_config_unicode\xe2\x9c\x93')
with mock.patch('sys.getfilesystemencoding') as encoding:

63
tests/unit/test_hooks.py
View file

@ -17,6 +17,7 @@ from tests import unittest
from functools import partial
from botocore.hooks import HierarchicalEmitter, first_non_none_response
from botocore.hooks import AliasedEventEmitter
class TestHierarchicalEventEmitter(unittest.TestCase):
@ -61,6 +62,68 @@ class TestHierarchicalEventEmitter(unittest.TestCase):
self.assertEqual(calls, ['foo.bar.baz', 'foo.bar', 'foo'])
class TestAliasedEventEmitter(unittest.TestCase):
def setUp(self):
self.hook_calls = []
def hook(self, **kwargs):
self.hook_calls.append(kwargs)
def test_event_emitted(self):
aliases = {'bar': 'bear'}
emitter = AliasedEventEmitter(event_aliases=aliases)
emitter.register('foo.bear.baz', self.hook)
emitter.emit('foo.bear.baz')
calls = [e['event_name'] for e in self.hook_calls]
self.assertEqual(calls, ['foo.bear.baz'])
def test_aliased_event_emitted(self):
aliases = {'bar': 'bear'}
emitter = AliasedEventEmitter(event_aliases=aliases)
emitter.register('foo.bear.baz', self.hook)
emitter.emit('foo.bar.baz')
calls = [e['event_name'] for e in self.hook_calls]
self.assertEqual(calls, ['foo.bear.baz'])
def test_aliased_event_registered(self):
aliases = {'bar': 'bear'}
emitter = AliasedEventEmitter(event_aliases=aliases)
emitter.register('foo.bar.baz', self.hook)
emitter.emit('foo.bear.baz')
calls = [e['event_name'] for e in self.hook_calls]
self.assertEqual(calls, ['foo.bear.baz'])
def test_event_unregistered(self):
aliases = {'bar': 'bear'}
emitter = AliasedEventEmitter(event_aliases=aliases)
emitter.register('foo.bar.baz', self.hook)
emitter.emit('foo.bear.baz')
calls = [e['event_name'] for e in self.hook_calls]
self.assertEqual(calls, ['foo.bear.baz'])
self.hook_calls = []
emitter.unregister('foo.bear.baz', self.hook)
emitter.emit('foo.bear.baz')
calls = [e['event_name'] for e in self.hook_calls]
self.assertEqual(calls, [])
def test_aliased_event_unregistered(self):
aliases = {'bar': 'bear'}
emitter = AliasedEventEmitter(event_aliases=aliases)
emitter.register('foo.bar.baz', self.hook)
emitter.emit('foo.bear.baz')
calls = [e['event_name'] for e in self.hook_calls]
self.assertEqual(calls, ['foo.bear.baz'])
self.hook_calls = []
emitter.unregister('foo.bar.baz', self.hook)
emitter.emit('foo.bear.baz')
calls = [e['event_name'] for e in self.hook_calls]
self.assertEqual(calls, [])
class TestStopProcessing(unittest.TestCase):
def setUp(self):
self.emitter = HierarchicalEmitter()

4
tests/unit/test_paginate.py
View file

@ -1171,7 +1171,7 @@ class TestIncludeNonResultKeys(unittest.TestCase):
{'Result': {'Key': ['bar', 'baz'], 'Inner': 'v3'},
'Outer': 'v4', 'NextToken': 't2'},
{'Result': {'Key': ['qux'], 'Inner': 'v5'},
'Outer': 'v6', 'NextToken': 't3'},
'Outer': 'v6'},
]
pages = self.paginator.paginate()
actual = pages.build_full_result()
@ -1404,7 +1404,7 @@ class TestStringPageSize(unittest.TestCase):
self.service = model.ServiceModel(self.service_model)
self.model = self.service.operation_model('ListStuff')
self.method = mock.Mock()
self.method.side_effect = []
self.method.side_effect = [{}]
self.paginator = Paginator(self.method, self.paginate_config, self.model)
def test_int_page_size(self):

30
tests/unit/test_session.py
View file

@ -327,13 +327,15 @@ class TestSessionPartitionFiles(BaseSessionTest):
def test_lists_partitions_on_disk(self):
mock_resolver = mock.Mock()
mock_resolver.get_available_partitions.return_value = ['foo']
self.session.register_component('endpoint_resolver', mock_resolver)
self.session._register_internal_component(
'endpoint_resolver', mock_resolver)
self.assertEqual(['foo'], self.session.get_available_partitions())
def test_proxies_list_endpoints_to_resolver(self):
resolver = mock.Mock()
resolver.get_available_endpoints.return_value = ['a', 'b']
self.session.register_component('endpoint_resolver', resolver)
self.session._register_internal_component(
'endpoint_resolver', resolver)
self.session.get_available_regions('foo', 'bar', True)
def test_provides_empty_list_for_unknown_service_regions(self):
@ -653,6 +655,30 @@ class TestCreateClient(BaseSessionTest):
self.assertEqual(call_kwargs['api_version'], override_api_version)
class TestSessionComponent(BaseSessionTest):
def test_internal_component(self):
component = object()
self.session._register_internal_component('internal', component)
self.assertIs(
self.session._get_internal_component('internal'), component)
with self.assertRaises(ValueError):
self.session.get_component('internal')
def test_internal_endpoint_resolver_is_same_as_deprecated_public(self):
endpoint_resolver = self.session._get_internal_component(
'endpoint_resolver')
self.assertIs(
self.session.get_component('endpoint_resolver'), endpoint_resolver)
def test_internal_exceptions_factory_is_same_as_deprecated_public(self):
exceptions_factory = self.session._get_internal_component(
'exceptions_factory')
self.assertIs(
self.session.get_component('exceptions_factory'),
exceptions_factory
)
class TestComponentLocator(unittest.TestCase):
def setUp(self):
self.components = botocore.session.ComponentLocator()

20
tests/unit/test_utils.py
View file

@ -1440,6 +1440,26 @@ class TestS3RegionRedirector(unittest.TestCase):
request_dict, response, self.operation)
self.assertIsNone(redirect_response)
def test_does_not_redirect_400_head_bucket_no_region_header(self):
# We should not redirect a 400 Head* if the region header is not
# present as this will lead to infinitely calling HeadBucket.
request_dict = {'url': 'https://us-west-2.amazonaws.com/foo',
'context': {'signing': {'bucket': 'foo'}}}
response = (None, {
'Error': {'Code': '400', 'Message': 'Bad Request'},
'ResponseMetadata': {
'HTTPHeaders': {}
}
})
self.operation.name = 'HeadBucket'
redirect_response = self.redirector.redirect_from_error(
request_dict, response, self.operation)
head_bucket_calls = self.client.head_bucket.call_count
self.assertIsNone(redirect_response)
# We should not have made an additional head bucket call
self.assertEqual(head_bucket_calls, 0)
def test_does_not_redirect_if_None_response(self):
request_dict = {'url': 'https://us-west-2.amazonaws.com/foo',
'context': {'signing': {'bucket': 'foo'}}}