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

New upstream version 1.12.241+repack

Browse source
This commit is contained in:
TANIGUCHI Takaki 2019-10-03 19:21:31 +09:00
parent 18782f0ac3
commit d2c90f6e4a
83 changed files with 12006 additions and 1827 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.12.208
Version: 1.12.241
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

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

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.12.208
Version: 1.12.241
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

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

@ -332,6 +332,10 @@ botocore/data/firehose/2015-08-04/paginators-1.json
botocore/data/firehose/2015-08-04/service-2.json
botocore/data/fms/2018-01-01/paginators-1.json
botocore/data/fms/2018-01-01/service-2.json
botocore/data/forecast/2018-06-26/paginators-1.json
botocore/data/forecast/2018-06-26/service-2.json
botocore/data/forecastquery/2018-06-26/paginators-1.json
botocore/data/forecastquery/2018-06-26/service-2.json
botocore/data/fsx/2018-03-01/paginators-1.json
botocore/data/fsx/2018-03-01/service-2.json
botocore/data/gamelift/2015-10-01/examples-1.json
@ -494,6 +498,10 @@ botocore/data/polly/2016-06-10/paginators-1.json
botocore/data/polly/2016-06-10/service-2.json
botocore/data/pricing/2017-10-15/paginators-1.json
botocore/data/pricing/2017-10-15/service-2.json
botocore/data/qldb-session/2019-07-11/paginators-1.json
botocore/data/qldb-session/2019-07-11/service-2.json
botocore/data/qldb/2019-01-02/paginators-1.json
botocore/data/qldb/2019-01-02/service-2.json
botocore/data/quicksight/2018-04-01/paginators-1.json
botocore/data/quicksight/2018-04-01/service-2.json
botocore/data/ram/2018-01-04/paginators-1.json
@ -616,6 +624,8 @@ botocore/data/worklink/2018-09-25/paginators-1.json
botocore/data/worklink/2018-09-25/service-2.json
botocore/data/workmail/2017-10-01/paginators-1.json
botocore/data/workmail/2017-10-01/service-2.json
botocore/data/workmailmessageflow/2019-05-01/paginators-1.json
botocore/data/workmailmessageflow/2019-05-01/service-2.json
botocore/data/workspaces/2015-04-08/examples-1.json
botocore/data/workspaces/2015-04-08/paginators-1.json
botocore/data/workspaces/2015-04-08/service-2.json

2
botocore.egg-info/requires.txt
View file

@ -1,5 +1,5 @@
jmespath<1.0.0,>=0.7.1
docutils<0.15,>=0.10
docutils<0.16,>=0.10
python-dateutil<3.0.0,>=2.1
urllib3<1.26,>=1.20

2
botocore/__init__.py
View file

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

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

@ -339,7 +339,7 @@
{"shape":"DeviceNotRegisteredException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.</p> <p>When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data. This action can be called once every 24 hours for a specific shared device. </p>"
"documentation":"<p>When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.</p>"
},
"DeleteGatewayGroup":{
"name":"DeleteGatewayGroup",
@ -2141,6 +2141,10 @@
"shape":"WakeWord",
"documentation":"<p>A wake word for Alexa, Echo, Amazon, or a computer.</p>"
},
"Locale":{
"shape":"DeviceLocale",
"documentation":"<p>The locale of the room profile.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>The user-specified token that is used during the creation of a profile.</p>",
@ -2683,6 +2687,11 @@
]
},
"DeviceEventValue":{"type":"string"},
"DeviceLocale":{
"type":"string",
"max":256,
"min":1
},
"DeviceName":{
"type":"string",
"max":100,
@ -2892,7 +2901,7 @@
"type":"string",
"max":128,
"min":1,
"pattern":"([0-9a-zA-Z]([+-.\\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\\w]*[0-9a-zA-Z]\\.)+[a-zA-Z]{2,9})"
"pattern":"([0-9a-zA-Z]([+-.\\w]*[0-9a-zA-Z])*@([0-9a-zA-Z]([-\\w]*[0-9a-zA-Z]+)*\\.)+[a-zA-Z]{2,9})"
},
"EnablementType":{
"type":"string",
@ -4042,6 +4051,10 @@
"shape":"WakeWord",
"documentation":"<p>The wake word of a room profile.</p>"
},
"Locale":{
"shape":"DeviceLocale",
"documentation":"<p>The locale of a room profile.</p>"
},
"SetupModeDisabled":{
"shape":"Boolean",
"documentation":"<p>The setup mode of a room profile.</p>"
@ -4095,6 +4108,10 @@
"WakeWord":{
"shape":"WakeWord",
"documentation":"<p>The wake word of a room profile.</p>"
},
"Locale":{
"shape":"DeviceLocale",
"documentation":"<p>The locale of a room profile.</p>"
}
},
"documentation":"<p>The data of a room profile.</p>"
@ -5621,6 +5638,10 @@
"shape":"WakeWord",
"documentation":"<p>The updated wake word for the room profile.</p>"
},
"Locale":{
"shape":"DeviceLocale",
"documentation":"<p>The updated locale for the room profile.</p>"
},
"SetupModeDisabled":{
"shape":"Boolean",
"documentation":"<p>Whether the setup mode of the profile is enabled.</p>"

279
botocore/data/amplify/2017-07-25/service-2.json
View file

@ -185,6 +185,22 @@
],
"documentation":"<p> Deletes a webhook. </p>"
},
"GenerateAccessLogs":{
"name":"GenerateAccessLogs",
"http":{
"method":"POST",
"requestUri":"/apps/{appId}/accesslogs"
},
"input":{"shape":"GenerateAccessLogsRequest"},
"output":{"shape":"GenerateAccessLogsResult"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p> Retrieve website access logs for a specific time range via a pre-signed URL. Optionally, deliver the logs to a given S3 bucket. </p>"
},
"GetApp":{
"name":"GetApp",
"http":{
@ -201,6 +217,23 @@
],
"documentation":"<p> Retrieves an existing Amplify App by appId. </p>"
},
"GetArtifactUrl":{
"name":"GetArtifactUrl",
"http":{
"method":"GET",
"requestUri":"/artifacts/{artifactId}"
},
"input":{"shape":"GetArtifactUrlRequest"},
"output":{"shape":"GetArtifactUrlResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p> Retrieves artifact info that corresponds to a artifactId. </p>"
},
"GetBranch":{
"name":"GetBranch",
"http":{
@ -282,6 +315,22 @@
],
"documentation":"<p> Lists existing Amplify Apps. </p>"
},
"ListArtifacts":{
"name":"ListArtifacts",
"http":{
"method":"GET",
"requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts"
},
"input":{"shape":"ListArtifactsRequest"},
"output":{"shape":"ListArtifactsResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p> List artifacts with an app, a branch, a job and an artifact type. </p>"
},
"ListBranches":{
"name":"ListBranches",
"http":{
@ -635,6 +684,44 @@
"type":"list",
"member":{"shape":"App"}
},
"Artifact":{
"type":"structure",
"required":[
"artifactFileName",
"artifactId"
],
"members":{
"artifactFileName":{
"shape":"ArtifactFileName",
"documentation":"<p> File name for the artifact. </p>"
},
"artifactId":{
"shape":"ArtifactId",
"documentation":"<p> Unique Id for a artifact. </p>"
}
},
"documentation":"<p> Structure for artifact. </p>"
},
"ArtifactFileName":{
"type":"string",
"max":1000
},
"ArtifactId":{
"type":"string",
"max":255
},
"ArtifactType":{
"type":"string",
"enum":["TEST"]
},
"ArtifactUrl":{
"type":"string",
"max":1000
},
"Artifacts":{
"type":"list",
"member":{"shape":"Artifact"}
},
"ArtifactsUrl":{
"type":"string",
"max":1000
@ -678,6 +765,10 @@
"buildSpec":{
"shape":"BuildSpec",
"documentation":"<p> BuildSpec for the auto created branch. </p>"
},
"enablePullRequestPreview":{
"shape":"EnablePullRequestPreview",
"documentation":"<p> Enables Pull Request Preview for auto created branch. </p>"
}
},
"documentation":"<p> Structure with auto branch creation config. </p>"
@ -722,7 +813,8 @@
"activeJobId",
"totalNumberOfJobs",
"enableBasicAuth",
"ttl"
"ttl",
"enablePullRequestPreview"
],
"members":{
"branchArn":{
@ -808,6 +900,18 @@
"associatedResources":{
"shape":"AssociatedResources",
"documentation":"<p> List of custom resources that are linked to this branch. </p>"
},
"enablePullRequestPreview":{
"shape":"EnablePullRequestPreview",
"documentation":"<p> Enables Pull Request Preview for this branch. </p>"
},
"destinationBranch":{
"shape":"BranchName",
"documentation":"<p> The destination branch if the branch is a pull request branch. </p>"
},
"sourceBranch":{
"shape":"BranchName",
"documentation":"<p> The source branch if the branch is a pull request branch. </p>"
}
},
"documentation":"<p> Branch for an Amplify App, which maps to a 3rd party repository branch. </p>"
@ -998,6 +1102,10 @@
"displayName":{
"shape":"DisplayName",
"documentation":"<p> Display name for a branch, will use as the default domain prefix. </p>"
},
"enablePullRequestPreview":{
"shape":"EnablePullRequestPreview",
"documentation":"<p> Enables Pull Request Preview for this branch. </p>"
}
},
"documentation":"<p> Request structure for a branch create request. </p>"
@ -1424,6 +1532,7 @@
"EnableBasicAuth":{"type":"boolean"},
"EnableBranchAutoBuild":{"type":"boolean"},
"EnableNotification":{"type":"boolean"},
"EnablePullRequestPreview":{"type":"boolean"},
"EndTime":{"type":"timestamp"},
"EnvKey":{
"type":"string",
@ -1460,6 +1569,44 @@
"type":"string",
"max":255
},
"GenerateAccessLogsRequest":{
"type":"structure",
"required":[
"domainName",
"appId"
],
"members":{
"startTime":{
"shape":"StartTime",
"documentation":"<p> The time at which the logs should start, inclusive. </p>"
},
"endTime":{
"shape":"EndTime",
"documentation":"<p> The time at which the logs should end, inclusive. </p>"
},
"domainName":{
"shape":"DomainName",
"documentation":"<p> Name of the domain. </p>"
},
"appId":{
"shape":"AppId",
"documentation":"<p> Unique Id for an Amplify App. </p>",
"location":"uri",
"locationName":"appId"
}
},
"documentation":"<p> Request structure for the generate access logs request. </p>"
},
"GenerateAccessLogsResult":{
"type":"structure",
"members":{
"logUrl":{
"shape":"LogUrl",
"documentation":"<p> Pre-signed URL for the requested access logs. </p>"
}
},
"documentation":"<p> Result structure for the generate access logs request. </p>"
},
"GetAppRequest":{
"type":"structure",
"required":["appId"],
@ -1480,6 +1627,37 @@
"app":{"shape":"App"}
}
},
"GetArtifactUrlRequest":{
"type":"structure",
"required":["artifactId"],
"members":{
"artifactId":{
"shape":"ArtifactId",
"documentation":"<p> Unique Id for a artifact. </p>",
"location":"uri",
"locationName":"artifactId"
}
},
"documentation":"<p> Request structure for the get artifact request. </p>"
},
"GetArtifactUrlResult":{
"type":"structure",
"required":[
"artifactId",
"artifactUrl"
],
"members":{
"artifactId":{
"shape":"ArtifactId",
"documentation":"<p> Unique Id for a artifact. </p>"
},
"artifactUrl":{
"shape":"ArtifactUrl",
"documentation":"<p> Presigned url for the artifact. </p>"
}
},
"documentation":"<p> Result structure for the get artifact request. </p>"
},
"GetBranchRequest":{
"type":"structure",
"required":[
@ -1763,6 +1941,66 @@
},
"documentation":"<p> Result structure for an Amplify App list request. </p>"
},
"ListArtifactsRequest":{
"type":"structure",
"required":[
"appId",
"branchName",
"jobId"
],
"members":{
"appId":{
"shape":"AppId",
"documentation":"<p> Unique Id for an Amplify App. </p>",
"location":"uri",
"locationName":"appId"
},
"branchName":{
"shape":"BranchName",
"documentation":"<p> Name for a branch, part of an Amplify App. </p>",
"location":"uri",
"locationName":"branchName"
},
"jobId":{
"shape":"JobId",
"documentation":"<p> Unique Id for an Job. </p>",
"location":"uri",
"locationName":"jobId"
},
"artifactType":{
"shape":"ArtifactType",
"documentation":"<p> Type for an artifact. </p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p> Pagination token. Set to null to start listing artifacts from start. If non-null pagination token is returned in a result, then pass its value in here to list more artifacts. </p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p> Maximum number of records to list in a single response. </p>",
"location":"querystring",
"locationName":"maxResults"
}
},
"documentation":"<p> Request structure for the list artifacts request. </p>"
},
"ListArtifactsResult":{
"type":"structure",
"required":["artifacts"],
"members":{
"artifacts":{
"shape":"Artifacts",
"documentation":"<p> List of artifacts. </p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p> Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries. </p>"
}
},
"documentation":"<p> Result structure for the list artifacts request. </p>"
},
"ListBranchesRequest":{
"type":"structure",
"required":["appId"],
@ -2063,7 +2301,8 @@
"PRODUCTION",
"BETA",
"DEVELOPMENT",
"EXPERIMENTAL"
"EXPERIMENTAL",
"PULL_REQUEST"
]
},
"StartDeploymentRequest":{
@ -2168,7 +2407,7 @@
"StartTime":{"type":"timestamp"},
"Status":{
"type":"string",
"max":3,
"max":7,
"min":3
},
"StatusReason":{
@ -2208,6 +2447,14 @@
"shape":"ArtifactsUrl",
"documentation":"<p> URL to the artifact for the execution step. </p>"
},
"testArtifactsUrl":{
"shape":"TestArtifactsUrl",
"documentation":"<p> URL to the test artifact for the execution step. </p>"
},
"testConfigUrl":{
"shape":"TestConfigUrl",
"documentation":"<p> URL to the test config for the execution step. </p>"
},
"screenshots":{
"shape":"Screenshots",
"documentation":"<p> List of screenshot URLs for the execution step, if relevant. </p>"
@ -2380,6 +2627,14 @@
"max":2048,
"min":1
},
"TestArtifactsUrl":{
"type":"string",
"max":1000
},
"TestConfigUrl":{
"type":"string",
"max":1000
},
"ThumbnailName":{
"type":"string",
"max":256
@ -2490,7 +2745,19 @@
},
"autoBranchCreationConfig":{
"shape":"AutoBranchCreationConfig",
"documentation":"<p> Automated branch creation config for the Amplify App. </p>"
"documentation":"<p> Automated branch creation branchConfig for the Amplify App. </p>"
},
"repository":{
"shape":"Repository",
"documentation":"<p> Repository for an Amplify App </p>"
},
"oauthToken":{
"shape":"OauthToken",
"documentation":"<p> OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored. </p>"
},
"accessToken":{
"shape":"AccessToken",
"documentation":"<p> Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored. </p>"
}
},
"documentation":"<p> Request structure for update App request. </p>"
@ -2568,6 +2835,10 @@
"displayName":{
"shape":"DisplayName",
"documentation":"<p> Display name for a branch, will use as the default domain prefix. </p>"
},
"enablePullRequestPreview":{
"shape":"EnablePullRequestPreview",
"documentation":"<p> Enables Pull Request Preview for this branch. </p>"
}
},
"documentation":"<p> Request structure for update branch request. </p>"

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

@ -407,7 +407,8 @@
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"NotFoundException"},
{"shape":"TooManyRequestsException"}
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Deletes the <a>DomainName</a> resource.</p>"
},
@ -3602,6 +3603,10 @@
"types":{
"shape":"ListOfEndpointType",
"documentation":"<p>A list of endpoint types of an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>). For an edge-optimized API and its custom domain name, the endpoint type is <code>\"EDGE\"</code>. For a regional API and its custom domain name, the endpoint type is <code>REGIONAL</code>. For a private API, the endpoint type is <code>PRIVATE</code>.</p>"
},
"vpcEndpointIds":{
"shape":"ListOfString",
"documentation":"<p>A list of VpcEndpointIds of an API (<a>RestApi</a>) against which to create Route53 ALIASes. It is only supported for <code>PRIVATE</code> endpoint type.</p>"
}
},
"documentation":"<p>The endpoint configuration to indicate the types of endpoints an API (<a>RestApi</a>) or its custom domain name (<a>DomainName</a>) has. </p>"

134
botocore/data/apigatewaymanagementapi/2018-11-29/service-2.json
View file

@ -11,6 +11,53 @@
"signatureVersion" : "v4"
},
"operations" : {
"DeleteConnection" : {
"name" : "DeleteConnection",
"http" : {
"method" : "DELETE",
"requestUri" : "/@connections/{connectionId}",
"responseCode" : 204
},
"input" : {
"shape" : "DeleteConnectionRequest"
},
"errors" : [ {
"shape" : "GoneException",
"documentation" : "<p>The connection with the provided id no longer exists.</p>"
}, {
"shape" : "LimitExceededException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.</p>"
}, {
"shape" : "ForbiddenException",
"documentation" : "<p>The caller is not authorized to invoke this operation.</p>"
} ],
"documentation" : "<p>Delete the connection with the provided id.</p>"
},
"GetConnection" : {
"name" : "GetConnection",
"http" : {
"method" : "GET",
"requestUri" : "/@connections/{connectionId}",
"responseCode" : 200
},
"input" : {
"shape" : "GetConnectionRequest"
},
"output" : {
"shape" : "GetConnectionResponse"
},
"errors" : [ {
"shape" : "GoneException",
"documentation" : "<p>The connection with the provided id no longer exists.</p>"
}, {
"shape" : "LimitExceededException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.</p>"
}, {
"shape" : "ForbiddenException",
"documentation" : "<p>The caller is not authorized to invoke this operation.</p>"
} ],
"documentation" : "<p>Get information about the connection with the provided id.</p>"
},
"PostToConnection" : {
"name" : "PostToConnection",
"http" : {
@ -26,7 +73,7 @@
"documentation" : "<p>The connection with the provided id no longer exists.</p>"
}, {
"shape" : "LimitExceededException",
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>"
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.</p>"
}, {
"shape" : "PayloadTooLargeException",
"documentation" : "<p>The data has exceeded the maximum size allowed.</p>"
@ -43,32 +90,80 @@
"max" : 131072,
"documentation" : "<p>The data to be sent to the client specified by its connection id.</p>"
},
"DeleteConnectionRequest" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "connectionId"
}
},
"required" : [ "ConnectionId" ]
},
"ForbiddenException" : {
"type" : "structure",
"members" : { },
"documentation" : "<p>The caller is not authorized to invoke this operation.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 403
}
},
"GetConnectionRequest" : {
"type" : "structure",
"members" : {
"ConnectionId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "connectionId"
}
},
"documentation" : "<p>The caller is not authorized to invoke this operation.</p>"
"required" : [ "ConnectionId" ]
},
"GetConnectionResponse" : {
"type" : "structure",
"members" : {
"ConnectedAt" : {
"shape" : "__timestampIso8601",
"locationName" : "connectedAt",
"documentation" : "<p>The time in ISO 8601 format for when the connection was established.</p>"
},
"Identity" : {
"shape" : "Identity",
"locationName" : "identity"
},
"LastActiveAt" : {
"shape" : "__timestampIso8601",
"locationName" : "lastActiveAt",
"documentation" : "<p>The time in ISO 8601 format for when the connection was last active.</p>"
}
}
},
"GoneException" : {
"type" : "structure",
"members" : { },
"documentation" : "<p>The connection with the provided id no longer exists.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 410
},
"documentation" : "<p>The connection with the provided id no longer exists.</p>"
}
},
"LimitExceededException" : {
"Identity" : {
"type" : "structure",
"members" : { },
"exception" : true,
"error" : {
"httpStatusCode" : 429
"members" : {
"SourceIp" : {
"shape" : "__string",
"locationName" : "sourceIp",
"documentation" : "<p>The source IP address of the TCP connection making the request to API Gateway.</p>"
},
"UserAgent" : {
"shape" : "__string",
"locationName" : "userAgent",
"documentation" : "<p>The User Agent of the API caller.</p>"
}
},
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>"
"required" : [ "SourceIp", "UserAgent" ]
},
"PayloadTooLargeException" : {
"type" : "structure",
@ -78,11 +173,11 @@
"locationName" : "message"
}
},
"documentation" : "<p>The data has exceeded the maximum size allowed.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 413
},
"documentation" : "<p>The data has exceeded the maximum size allowed.</p>"
}
},
"PostToConnectionRequest" : {
"type" : "structure",
@ -101,9 +196,22 @@
"required" : [ "ConnectionId", "Data" ],
"payload" : "Data"
},
"LimitExceededException" : {
"type" : "structure",
"members" : { },
"documentation" : "<p>The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.</p>",
"exception" : true,
"error" : {
"httpStatusCode" : 429
}
},
"__string" : {
"type" : "string"
},
"__timestampIso8601" : {
"type" : "timestamp",
"timestampFormat" : "iso8601"
}
},
"documentation" : "<p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>"
}
}

28
botocore/data/application-autoscaling/2016-02-06/service-2.json
View file

@ -770,6 +770,10 @@
"RoleARN":{
"shape":"ResourceIdMaxLen1600",
"documentation":"<p>Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>"
},
"SuspendedState":{
"shape":"SuspendedState",
"documentation":"<p>An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to <code>true</code> suspends the specified scaling activities. Setting it to <code>false</code> (default) resumes the specified scaling activities. </p> <p> <b>Suspension Outcomes</b> </p> <ul> <li> <p>For <code>DynamicScalingInSuspended</code>, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.</p> </li> <li> <p>For <code>DynamicScalingOutSuspended</code>, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.</p> </li> <li> <p>For <code>ScheduledScalingSuspended</code>, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html\">Suspend and Resume Application Auto Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>"
}
}
},
@ -853,7 +857,8 @@
"CreationTime":{
"shape":"TimestampType",
"documentation":"<p>The Unix timestamp for when the scalable target was created.</p>"
}
},
"SuspendedState":{"shape":"SuspendedState"}
},
"documentation":"<p>Represents a scalable target.</p>"
},
@ -1010,6 +1015,7 @@
},
"documentation":"<p>Represents a scaling policy to use with Application Auto Scaling.</p>"
},
"ScalingSuspended":{"type":"boolean"},
"ScheduledAction":{
"type":"structure",
"required":[
@ -1136,6 +1142,24 @@
},
"documentation":"<p>Represents a step scaling policy configuration to use with Application Auto Scaling.</p>"
},
"SuspendedState":{
"type":"structure",
"members":{
"DynamicScalingInSuspended":{
"shape":"ScalingSuspended",
"documentation":"<p>Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to <code>true</code> if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is <code>false</code>. </p>"
},
"DynamicScalingOutSuspended":{
"shape":"ScalingSuspended",
"documentation":"<p>Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to <code>true</code> if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is <code>false</code>. </p>"
},
"ScheduledScalingSuspended":{
"shape":"ScalingSuspended",
"documentation":"<p>Whether scheduled scaling is suspended. Set the value to <code>true</code> if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is <code>false</code>. </p>"
}
},
"documentation":"<p>Specifies whether the scaling activities for a scalable target are in a suspended state. </p>"
},
"TargetTrackingScalingPolicyConfiguration":{
"type":"structure",
"required":["TargetValue"],
@ -1181,5 +1205,5 @@
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
}
},
"documentation":"<p>With Application Auto Scaling, you can configure automatic scaling for the following resources:</p> <ul> <li> <p>Amazon ECS services</p> </li> <li> <p>Amazon EC2 Spot Fleet requests</p> </li> <li> <p>Amazon EMR clusters</p> </li> <li> <p>Amazon AppStream 2.0 fleets </p> </li> <li> <p>Amazon DynamoDB tables and global secondary indexes throughput capacity</p> </li> <li> <p>Amazon Aurora Replicas</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources provided by your own applications or services</p> </li> </ul> <p> <b>API Summary</b> </p> <p>The Application Auto Scaling service API includes two key sets of actions: </p> <ul> <li> <p>Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.</p> </li> <li> <p>Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.</p> </li> </ul> <p>To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
"documentation":"<p>With Application Auto Scaling, you can configure automatic scaling for the following resources:</p> <ul> <li> <p>Amazon ECS services</p> </li> <li> <p>Amazon EC2 Spot Fleet requests</p> </li> <li> <p>Amazon EMR clusters</p> </li> <li> <p>Amazon AppStream 2.0 fleets </p> </li> <li> <p>Amazon DynamoDB tables and global secondary indexes throughput capacity</p> </li> <li> <p>Amazon Aurora Replicas</p> </li> <li> <p>Amazon SageMaker endpoint variants</p> </li> <li> <p>Custom resources provided by your own applications or services</p> </li> </ul> <p> <b>API Summary</b> </p> <p>The Application Auto Scaling service API includes three key sets of actions: </p> <ul> <li> <p>Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.</p> </li> <li> <p>Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.</p> </li> <li> <p>Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the <a>RegisterScalableTarget</a> action for any Application Auto Scaling scalable target. You can suspend and resume, individually or in combination, scale-out activities triggered by a scaling policy, scale-in activities triggered by a scaling policy, and scheduled scaling. </p> </li> </ul> <p>To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>"
}

236
botocore/data/appmesh/2019-01-25/service-2.json
View file

@ -677,6 +677,9 @@
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
@ -685,6 +688,9 @@
},
{
"shape": "ServiceUnavailableException"
},
{
"shape": "TooManyRequestsException"
}
],
"documentation": "<p>List the tags for an App Mesh resource.</p>"
@ -811,6 +817,9 @@
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
@ -820,6 +829,9 @@
{
"shape": "ServiceUnavailableException"
},
{
"shape": "TooManyRequestsException"
},
{
"shape": "TooManyTagsException"
}
@ -844,6 +856,9 @@
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
@ -852,6 +867,9 @@
},
{
"shape": "ServiceUnavailableException"
},
{
"shape": "TooManyRequestsException"
}
],
"documentation": "<p>Deletes specified tags from a resource.</p>",
@ -1125,6 +1143,14 @@
},
"documentation": ""
},
"TcpRetryPolicyEvents": {
"type": "list",
"member": {
"shape": "TcpRetryPolicyEvent"
},
"min": 1,
"max": 1
},
"CreateVirtualServiceInput": {
"type": "structure",
"required": [
@ -1787,6 +1813,36 @@
},
"documentation": "<p>An object representing a virtual service returned by a describe operation.</p>"
},
"Boolean": {
"type": "boolean",
"box": true
},
"HttpRouteHeader": {
"type": "structure",
"required": [
"name"
],
"members": {
"invert": {
"shape": "Boolean",
"documentation": "<p>Specify <code>True</code> to match the opposite of the <code>HeaderMatchMethod</code> method and value. The default value is <code>False</code>.</p>"
},
"match": {
"shape": "HeaderMatchMethod",
"documentation": "<p>The <code>HeaderMatchMethod</code> object.</p>"
},
"name": {
"shape": "HeaderName",
"documentation": "<p>A name for the HTTP header in the client request that will be matched on.</p>"
}
},
"documentation": "<p>An object representing the HTTP header in the request.</p>"
},
"HttpRetryPolicyEvent": {
"type": "string",
"min": 1,
"max": 25
},
"DescribeVirtualServiceOutput": {
"type": "structure",
"required": [
@ -2049,6 +2105,12 @@
},
"documentation": "<p>An object representing the AWS Cloud Map attribute information for your virtual node.</p>"
},
"TcpRetryPolicyEvent": {
"type": "string",
"enum": [
"connection-error"
]
},
"VirtualServiceSpec": {
"type": "structure",
"members": {
@ -2069,6 +2131,24 @@
},
"documentation": "<p>An object representing the backends that a virtual node is expected to send outbound\n traffic to. </p>"
},
"MatchRange": {
"type": "structure",
"required": [
"end",
"start"
],
"members": {
"end": {
"shape": "Long",
"documentation": "<p>The end of the range.</p>"
},
"start": {
"shape": "Long",
"documentation": "<p>The start of the range.</p>"
}
},
"documentation": "<p>The range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.</p>"
},
"ListVirtualRoutersLimit": {
"type": "integer",
"box": true,
@ -2211,6 +2291,19 @@
},
"documentation": ""
},
"DurationUnit": {
"type": "string",
"enum": [
"ms",
"s"
]
},
"RoutePriority": {
"type": "integer",
"box": true,
"min": 0,
"max": 1000
},
"ListVirtualServicesInput": {
"type": "structure",
"required": [
@ -2364,6 +2457,14 @@
},
"documentation": "<p>An object representing the status of a virtual service.</p>"
},
"HttpRetryPolicyEvents": {
"type": "list",
"member": {
"shape": "HttpRetryPolicyEvent"
},
"min": 1,
"max": 25
},
"ListVirtualNodesLimit": {
"type": "integer",
"box": true,
@ -2421,6 +2522,11 @@
"Timestamp": {
"type": "timestamp"
},
"HeaderMatch": {
"type": "string",
"min": 1,
"max": 255
},
"VirtualNodeSpec": {
"type": "structure",
"members": {
@ -2468,6 +2574,34 @@
"min": 1,
"max": 1
},
"HttpMethod": {
"type": "string",
"enum": [
"CONNECT",
"DELETE",
"GET",
"HEAD",
"OPTIONS",
"PATCH",
"POST",
"PUT",
"TRACE"
]
},
"Duration": {
"type": "structure",
"members": {
"unit": {
"shape": "DurationUnit",
"documentation": "<p>The unit of time between retry attempts.</p>"
},
"value": {
"shape": "DurationValue",
"documentation": "<p>The duration of time between retry attempts.</p>"
}
},
"documentation": "<p>An object representing the duration between retry attempts.</p>"
},
"ConflictException": {
"type": "structure",
"members": {
@ -2503,9 +2637,21 @@
"prefix"
],
"members": {
"headers": {
"shape": "HttpRouteHeaders",
"documentation": "<p>The client request headers to match on.</p>"
},
"method": {
"shape": "HttpMethod",
"documentation": "<p>The client request header method to match on.</p>"
},
"prefix": {
"shape": "String",
"documentation": "<p>Specifies the path to match requests with. This parameter must always start with\n <code>/</code>, which by itself matches all requests to the virtual service name. You\n can also match for path-based routing of requests. For example, if your virtual service\n name is <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>"
},
"scheme": {
"shape": "HttpScheme",
"documentation": "<p>The client request header scheme to match on.</p>"
}
},
"documentation": "<p>An object representing the requirements for a route to match HTTP requests for a virtual\n router.</p>"
@ -2551,6 +2697,11 @@
},
"documentation": "<p>An object representing a service mesh returned by a list operation.</p>"
},
"MaxRetries": {
"type": "long",
"box": true,
"min": 0
},
"MeshStatusCode": {
"type": "string",
"enum": [
@ -2868,6 +3019,11 @@
"fault": true
}
},
"HeaderName": {
"type": "string",
"min": 1,
"max": 50
},
"TagList": {
"type": "list",
"member": {
@ -2876,6 +3032,32 @@
"min": 0,
"max": 50
},
"HttpRetryPolicy": {
"type": "structure",
"required": [
"maxRetries",
"perRetryTimeout"
],
"members": {
"httpRetryEvents": {
"shape": "HttpRetryPolicyEvents",
"documentation": "<p>Specify at least one of the following values.</p>\n <ul>\n <li>\n <p>\n <b>server-error</b> – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511</p>\n </li>\n <li>\n <p>\n <b>gateway-error</b> – HTTP status codes 502,\n 503, and 504</p>\n </li>\n <li>\n <p>\n <b>client-error</b> – HTTP status code 409</p>\n </li>\n <li>\n <p>\n <b>stream-error</b> – Retry on refused\n stream</p>\n </li>\n </ul>"
},
"maxRetries": {
"shape": "MaxRetries",
"documentation": "<p>The maximum number of retry attempts. If no value is specified, the default is 1.</p>"
},
"perRetryTimeout": {
"shape": "Duration",
"documentation": "<p>An object that represents the retry duration.</p>"
},
"tcpRetryEvents": {
"shape": "TcpRetryPolicyEvents",
"documentation": "<p>Specify a valid value.</p>"
}
},
"documentation": "<p>An object that represents a retry policy.</p>"
},
"DescribeVirtualRouterInput": {
"type": "structure",
"required": [
@ -2939,6 +3121,32 @@
"senderFault": true
}
},
"HeaderMatchMethod": {
"type": "structure",
"members": {
"exact": {
"shape": "HeaderMatch",
"documentation": "<p>The header value sent by the client must match the specified value exactly.</p>"
},
"prefix": {
"shape": "HeaderMatch",
"documentation": "<p>The header value sent by the client must begin with the specified characters.</p>"
},
"range": {
"shape": "MatchRange",
"documentation": "<p>The object that specifies the range of numbers that the header value sent by the client must be included in.</p>"
},
"regex": {
"shape": "HeaderMatch",
"documentation": "<p>The header value sent by the client must include the specified characters.</p>"
},
"suffix": {
"shape": "HeaderMatch",
"documentation": "<p>The header value sent by the client must end with the specified characters.</p>"
}
},
"documentation": "<p>An object representing the method and value to match the header value sent with a request. Specify one match method.</p>"
},
"DeleteMeshOutput": {
"type": "structure",
"required": [
@ -2960,6 +3168,11 @@
"DROP_ALL"
]
},
"DurationValue": {
"type": "long",
"box": true,
"min": 0
},
"Hostname": {
"type": "string"
},
@ -3037,6 +3250,14 @@
"min": 1,
"max": 10
},
"HttpRouteHeaders": {
"type": "list",
"member": {
"shape": "HttpRouteHeader"
},
"min": 1,
"max": 10
},
"VirtualServiceProvider": {
"type": "structure",
"members": {
@ -3076,6 +3297,13 @@
},
"documentation": "<p>An object representing the AWS Cloud Map service discovery information for your virtual\n node.</p>"
},
"HttpScheme": {
"type": "string",
"enum": [
"http",
"https"
]
},
"UpdateVirtualServiceOutput": {
"type": "structure",
"required": [
@ -3195,6 +3423,10 @@
"shape": "HttpRoute",
"documentation": "<p>The HTTP routing information for the route.</p>"
},
"priority": {
"shape": "RoutePriority",
"documentation": "<p>The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.</p>"
},
"tcpRoute": {
"shape": "TcpRoute",
"documentation": "<p>The TCP routing information for the route.</p>"
@ -3216,6 +3448,10 @@
"match": {
"shape": "HttpRouteMatch",
"documentation": "<p>The criteria for determining an HTTP request match.</p>"
},
"retryPolicy": {
"shape": "HttpRetryPolicy",
"documentation": "<p>An object that represents a retry policy.</p>"
}
},
"documentation": "<p>An object representing the HTTP routing specification for a route.</p>"

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

@ -190,7 +190,8 @@
"output":{"shape":"CreateUsageReportSubscriptionResult"},
"errors":[
{"shape":"InvalidRoleException"},
{"shape":"InvalidAccountStatusException"}
{"shape":"InvalidAccountStatusException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a usage report subscription. Usage reports are generated daily.</p>"
},
@ -543,7 +544,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>"
},
"StartFleet":{
"name":"StartFleet",
@ -558,7 +559,9 @@
{"shape":"OperationNotPermittedException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"ConcurrentModificationException"}
{"shape":"ConcurrentModificationException"},
{"shape":"ResourceNotAvailableException"},
{"shape":"InvalidRoleException"}
],
"documentation":"<p>Starts the specified fleet.</p>"
},
@ -621,7 +624,7 @@
{"shape":"InvalidAccountStatusException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -634,7 +637,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>"
},
"UpdateDirectoryConfig":{
"name":"UpdateDirectoryConfig",
@ -671,7 +674,7 @@
{"shape":"IncompatibleImageException"},
{"shape":"OperationNotPermittedException"}
],
"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>, <code>ComputeCapacity</code>, <code>ImageARN</code>, <code>ImageName</code>, and <code>DisconnectTimeoutInSeconds</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>"
"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>, <code>ComputeCapacity</code>, <code>ImageARN</code>, <code>ImageName</code>, <code>IdleDisconnectTimeoutInSeconds</code>, and <code>DisconnectTimeoutInSeconds</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",
@ -711,6 +714,31 @@
}
},
"shapes":{
"AccessEndpoint":{
"type":"structure",
"required":["EndpointType"],
"members":{
"EndpointType":{
"shape":"AccessEndpointType",
"documentation":"<p>The type of interface endpoint.</p>"
},
"VpceId":{
"shape":"String",
"documentation":"<p>The identifier (ID) of the VPC in which the interface endpoint is used.</p>"
}
},
"documentation":"<p>Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.</p>"
},
"AccessEndpointList":{
"type":"list",
"member":{"shape":"AccessEndpoint"},
"max":4,
"min":1
},
"AccessEndpointType":{
"type":"string",
"enum":["STREAMING"]
},
"AccountName":{
"type":"string",
"min":1,
@ -1066,11 +1094,15 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>"
},
"IdleDisconnectTimeoutInSeconds":{
"shape":"Integer",
"documentation":"<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>"
},
"IamRoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials.</p>"
}
}
},
@ -1118,6 +1150,10 @@
"shape":"VpcConfig",
"documentation":"<p>The VPC configuration for the image builder. You can specify only one subnet.</p>"
},
"IamRoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials.</p>"
},
"EnableDefaultInternetAccess":{
"shape":"BooleanObject",
"documentation":"<p>Enables or disables default internet access for the image builder.</p>"
@ -1132,7 +1168,11 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>"
},
"AccessEndpoints":{
"shape":"AccessEndpointList",
"documentation":"<p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.</p>"
}
}
},
@ -1210,7 +1250,11 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>"
},
"AccessEndpoints":{
"shape":"AccessEndpointList",
"documentation":"<p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>"
}
}
},
@ -1253,7 +1297,7 @@
},
"SessionContext":{
"shape":"String",
"documentation":"<p>The session context. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<p>The session context. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>"
}
}
},
@ -1960,7 +2004,7 @@
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN for the fleet.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the fleet.</p>"
},
"Name":{
"shape":"String",
@ -2029,6 +2073,10 @@
"IdleDisconnectTimeoutInSeconds":{
"shape":"Integer",
"documentation":"<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>"
},
"IamRoleArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials.</p>"
}
},
"documentation":"<p>Describes a fleet.</p>"
@ -2039,7 +2087,8 @@
"enum":[
"VPC_CONFIGURATION",
"VPC_CONFIGURATION_SECURITY_GROUP_IDS",
"DOMAIN_JOIN_INFO"
"DOMAIN_JOIN_INFO",
"IAM_ROLE_ARN"
]
},
"FleetAttributes":{
@ -2070,6 +2119,8 @@
"NETWORK_INTERFACE_LIMIT_EXCEEDED",
"INTERNAL_SERVICE_ERROR",
"IAM_SERVICE_ROLE_IS_MISSING",
"MACHINE_ROLE_IS_MISSING",
"STS_DISABLED_IN_REGION",
"SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES",
"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION",
"SUBNET_NOT_FOUND",
@ -2224,6 +2275,10 @@
"shape":"PlatformType",
"documentation":"<p>The operating system platform of the image builder.</p>"
},
"IamRoleArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. </p>"
},
"State":{
"shape":"ImageBuilderState",
"documentation":"<p>The state of the image builder.</p>"
@ -2252,6 +2307,10 @@
"AppstreamAgentVersion":{
"shape":"AppstreamAgentVersion",
"documentation":"<p>The version of the AppStream 2.0 agent that is currently being used by the image builder. </p>"
},
"AccessEndpoints":{
"shape":"AccessEndpointList",
"documentation":"<p>The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.</p>"
}
},
"documentation":"<p>Describes a virtual machine that is used to create an image. </p>"
@ -2784,6 +2843,10 @@
"ApplicationSettings":{
"shape":"ApplicationSettingsResponse",
"documentation":"<p>The persistent application settings for users of the stack.</p>"
},
"AccessEndpoints":{
"shape":"AccessEndpointList",
"documentation":"<p>The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. </p>"
}
},
"documentation":"<p>Describes a stack.</p>"
@ -2798,7 +2861,9 @@
"REDIRECT_URL",
"FEEDBACK_URL",
"THEME_NAME",
"USER_SETTINGS"
"USER_SETTINGS",
"IAM_ROLE_ARN",
"ACCESS_ENDPOINTS"
]
},
"StackAttributes":{
@ -3120,6 +3185,10 @@
"AttributesToDelete":{
"shape":"FleetAttributes",
"documentation":"<p>The fleet attributes to delete.</p>"
},
"IamRoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials.</p>"
}
}
},
@ -3203,6 +3272,10 @@
"ApplicationSettings":{
"shape":"ApplicationSettings",
"documentation":"<p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>"
},
"AccessEndpoints":{
"shape":"AccessEndpointList",
"documentation":"<p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>"
}
}
},
@ -3423,5 +3496,5 @@
"documentation":"<p>Describes VPC configuration information for fleets and image builders.</p>"
}
},
"documentation":"<fullname>Amazon AppStream 2.0</fullname> <p>This is the <i>Amazon AppStream 2.0 API Reference</i>. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.</p> <p>To learn more about AppStream 2.0, see the following resources:</p> <ul> <li> <p> <a href=\"http://aws.amazon.com/appstream2\">Amazon AppStream 2.0 product page</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/appstream2\">Amazon AppStream 2.0 documentation</a> </p> </li> </ul>"
"documentation":"<fullname>Amazon AppStream 2.0</fullname> <p>This is the <i>Amazon AppStream 2.0 API Reference</i>. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand. </p> <note> <p>You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html\">Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p> </note> <p>To learn more about AppStream 2.0, see the following resources:</p> <ul> <li> <p> <a href=\"http://aws.amazon.com/appstream2\">Amazon AppStream 2.0 product page</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/appstream2\">Amazon AppStream 2.0 documentation</a> </p> </li> </ul>"
}

32
botocore/data/athena/2017-05-18/service-2.json
View file

@ -139,7 +139,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code> if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>"
"documentation":"<p>Streams the results of a single query execution specified by <code>QueryExecutionId</code> from the Athena query results location in Amazon S3. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> in the <i>Amazon Athena User Guide</i>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p> <p>To stream query results successfully, the IAM principal with permission to call <code>GetQueryResults</code> also must have permissions to the Amazon S3 <code>GetObject</code> action for the Athena query results location.</p> <important> <p>IAM principals with permission to the Amazon S3 <code>GetObject</code> action for the query results location are able to retrieve query results from Amazon S3 even if permission to the <code>GetQueryResults</code> action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.</p> </important>"
},
"GetWorkGroup":{
"name":"GetWorkGroup",
@ -815,7 +815,7 @@
"type":"integer",
"box":true,
"max":1000,
"min":0
"min":1
},
"MaxTagsCount":{
"type":"integer",
@ -908,7 +908,7 @@
},
"Statistics":{
"shape":"QueryExecutionStatistics",
"documentation":"<p>The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.</p>"
"documentation":"<p>The location of a manifest file that tracks file locations generated by the query, the amount of data scanned by the query, and the amount of time that it took the query to run.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
@ -958,9 +958,13 @@
"DataScannedInBytes":{
"shape":"Long",
"documentation":"<p>The number of bytes in the data that was queried.</p>"
},
"DataManifestLocation":{
"shape":"String",
"documentation":"<p>The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. It tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Working with Query Output Files</a> in the <i>Amazon Athena User Guide</i>.</p>"
}
},
"documentation":"<p>The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.</p>"
"documentation":"<p>The location of a manifest file that tracks file locations generated by the query, the amount of data scanned by the query, and the amount of time that it took the query to run.</p>"
},
"QueryExecutionStatus":{
"type":"structure",
@ -1003,21 +1007,21 @@
"members":{
"OutputLocation":{
"shape":"String",
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using <a>WorkGroupConfiguration</a>. If none of them is set, Athena issues an error that no output location is provided. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a>. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"EncryptionConfiguration":{
"shape":"EncryptionConfiguration",
"documentation":"<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>"
}
},
"documentation":"<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.</p>"
"documentation":"<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.</p>"
},
"ResultConfigurationUpdates":{
"type":"structure",
"members":{
"OutputLocation":{
"shape":"String",
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
"documentation":"<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"RemoveOutputLocation":{
"shape":"BoxedBoolean",
@ -1313,7 +1317,7 @@
},
"Configuration":{
"shape":"WorkGroupConfiguration",
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
},
"Description":{
"shape":"WorkGroupDescriptionString",
@ -1331,7 +1335,7 @@
"members":{
"ResultConfiguration":{
"shape":"ResultConfiguration",
"documentation":"<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>"
"documentation":"<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using <a>ResultConfiguration$OutputLocation</a>. If none of them is set, Athena issues an error that no output location is provided. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Query Results</a>.</p>"
},
"EnforceWorkGroupConfiguration":{
"shape":"BoxedBoolean",
@ -1344,9 +1348,13 @@
"BytesScannedCutoffPerQuery":{
"shape":"BytesScannedCutoffValue",
"documentation":"<p>The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"
},
"RequesterPaysEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to <code>true</code>, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <code>false</code>. For more information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>. </p>"
},
"WorkGroupConfigurationUpdates":{
"type":"structure",
@ -1370,6 +1378,10 @@
"RemoveBytesScannedCutoffPerQuery":{
"shape":"BoxedBoolean",
"documentation":"<p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a> </p>"
},
"RequesterPaysEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to <code>true</code>, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <code>false</code>. For more information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.</p>"

99
botocore/data/codecommit/2015-04-13/service-2.json
View file

File diff suppressed because one or more lines are too long

222
botocore/data/codepipeline/2015-07-09/service-2.json
View file

File diff suppressed because one or more lines are too long

663
botocore/data/comprehendmedical/2018-10-30/service-2.json
View file

@ -14,6 +14,38 @@
"uid":"comprehendmedical-2018-10-30"
},
"operations":{
"DescribeEntitiesDetectionV2Job":{
"name":"DescribeEntitiesDetectionV2Job",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEntitiesDetectionV2JobRequest"},
"output":{"shape":"DescribeEntitiesDetectionV2JobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.</p>"
},
"DescribePHIDetectionJob":{
"name":"DescribePHIDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribePHIDetectionJobRequest"},
"output":{"shape":"DescribePHIDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.</p>"
},
"DetectEntities":{
"name":"DetectEntities",
"http":{
@ -30,7 +62,27 @@
{"shape":"InvalidEncodingException"},
{"shape":"TextSizeLimitExceededException"}
],
"documentation":"<p> Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .</p>"
"documentation":"<p>The <code>DetectEntities</code> operation is deprecated. You should use the <a>DetectEntitiesV2</a> operation instead.</p> <p> Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .</p>",
"deprecated":true,
"deprecatedMessage":"This operation is deprecated, use DetectEntitiesV2 instead."
},
"DetectEntitiesV2":{
"name":"DetectEntitiesV2",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetectEntitiesV2Request"},
"output":{"shape":"DetectEntitiesV2Response"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ServiceUnavailableException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidEncodingException"},
{"shape":"TextSizeLimitExceededException"}
],
"documentation":"<p>Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.</p> <p>The <code>DetectEntitiesV2</code> operation replaces the <a>DetectEntities</a> operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the <code>DetectEntitiesV2</code> operation in all new applications.</p> <p>The <code>DetectEntitiesV2</code> operation returns the <code>Acuity</code> and <code>Direction</code> entities as attributes instead of types. It does not return the <code>Quality</code> or <code>Quantity</code> entities.</p>"
},
"DetectPHI":{
"name":"DetectPHI",
@ -48,10 +100,105 @@
{"shape":"InvalidEncodingException"},
{"shape":"TextSizeLimitExceededException"}
],
"documentation":"<p> Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.</p>"
"documentation":"<p> Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.</p>"
},
"ListEntitiesDetectionV2Jobs":{
"name":"ListEntitiesDetectionV2Jobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListEntitiesDetectionV2JobsRequest"},
"output":{"shape":"ListEntitiesDetectionV2JobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ValidationException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets a list of medical entity detection jobs that you have submitted.</p>"
},
"ListPHIDetectionJobs":{
"name":"ListPHIDetectionJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListPHIDetectionJobsRequest"},
"output":{"shape":"ListPHIDetectionJobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ValidationException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Gets a list of protected health information (PHI) detection jobs that you have submitted.</p>"
},
"StartEntitiesDetectionV2Job":{
"name":"StartEntitiesDetectionV2Job",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartEntitiesDetectionV2JobRequest"},
"output":{"shape":"StartEntitiesDetectionV2JobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous medical entity detection job for a collection of documents. Use the <code>DescribeEntitiesDetectionV2Job</code> operation to track the status of a job.</p>"
},
"StartPHIDetectionJob":{
"name":"StartPHIDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartPHIDetectionJobRequest"},
"output":{"shape":"StartPHIDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Starts an asynchronous job to detect protected health information (PHI). Use the <code>DescribePHIDetectionJob</code> operation to track the status of a job.</p>"
},
"StopEntitiesDetectionV2Job":{
"name":"StopEntitiesDetectionV2Job",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopEntitiesDetectionV2JobRequest"},
"output":{"shape":"StopEntitiesDetectionV2JobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a medical entities detection job in progress.</p>"
},
"StopPHIDetectionJob":{
"name":"StopPHIDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopPHIDetectionJobRequest"},
"output":{"shape":"StopPHIDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Stops a protected health information (PHI) detection job in progress.</p>"
}
},
"shapes":{
"AnyLengthString":{"type":"string"},
"Attribute":{
"type":"structure",
"members":{
@ -61,11 +208,11 @@
},
"Score":{
"shape":"Float",
"documentation":"<p> The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute. </p>"
"documentation":"<p> The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute. </p>"
},
"RelationshipScore":{
"shape":"Float",
"documentation":"<p> The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity. </p>"
"documentation":"<p> The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity. </p>"
},
"Id":{
"shape":"Integer",
@ -108,6 +255,138 @@
"max":20000,
"min":1
},
"ClientRequestTokenString":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9-]+$"
},
"ComprehendMedicalAsyncJobFilter":{
"type":"structure",
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>Filters on the name of the job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>Filters the list of jobs based on job status. Returns only jobs with the specified status.</p>"
},
"SubmitTimeBefore":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
},
"SubmitTimeAfter":{
"shape":"Timestamp",
"documentation":"<p>Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.</p>"
}
},
"documentation":"<p>Provides information for filtering a list of detection jobs.</p>"
},
"ComprehendMedicalAsyncJobProperties":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier assigned to the detection job.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The name that you assigned to the detection job.</p>"
},
"JobStatus":{
"shape":"JobStatus",
"documentation":"<p>The current status of the detection job. If the status is <code>FAILED</code>, the <code>Message</code> field shows the reason for the failure.</p>"
},
"Message":{
"shape":"AnyLengthString",
"documentation":"<p>A description of the status of a job.</p>"
},
"SubmitTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the detection job was submitted for processing.</p>"
},
"EndTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the detection job completed.</p>"
},
"ExpirationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the <code>ListEntitiesDetectionV2Job</code> or the <code>ListPHIDetectionJobs</code> operation.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>The input data configuration that you supplied when you created the detection job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>The output data configuration that you supplied when you created the detection job.</p>"
},
"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 Medical read access to your input data.</p>"
},
"ManifestFilePath":{
"shape":"ManifestFilePath",
"documentation":"<p>The path to the file that describes the results of a batch job.</p>"
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>The AWS Key Management Service key, if any, used to encrypt the output files. </p>"
},
"ModelVersion":{
"shape":"ModelVersion",
"documentation":"<p>The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.</p>"
}
},
"documentation":"<p>Provides information about a detection job.</p>"
},
"ComprehendMedicalAsyncJobPropertiesList":{
"type":"list",
"member":{"shape":"ComprehendMedicalAsyncJobProperties"}
},
"DescribeEntitiesDetectionV2JobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier that Amazon Comprehend Medical generated for the job. The <code>StartEntitiesDetectionV2Job</code> operation returns this identifier in its response.</p>"
}
}
},
"DescribeEntitiesDetectionV2JobResponse":{
"type":"structure",
"members":{
"ComprehendMedicalAsyncJobProperties":{
"shape":"ComprehendMedicalAsyncJobProperties",
"documentation":"<p>An object that contains the properties associated with a detection job.</p>"
}
}
},
"DescribePHIDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier that Amazon Comprehend Medical generated for the job. The <code>StartPHIDetectionJob</code> operation returns this identifier in its response.</p>"
}
}
},
"DescribePHIDetectionJobResponse":{
"type":"structure",
"members":{
"ComprehendMedicalAsyncJobProperties":{
"shape":"ComprehendMedicalAsyncJobProperties",
"documentation":"<p>An object that contains the properties associated with a detection job.</p>"
}
}
},
"DetectEntitiesRequest":{
"type":"structure",
"required":["Text"],
@ -120,11 +399,14 @@
},
"DetectEntitiesResponse":{
"type":"structure",
"required":["Entities"],
"required":[
"Entities",
"ModelVersion"
],
"members":{
"Entities":{
"shape":"EntityList",
"documentation":"<p> The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.</p>"
"documentation":"<p> The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.</p>"
},
"UnmappedAttributes":{
"shape":"UnmappedAttributeList",
@ -132,7 +414,46 @@
},
"PaginationToken":{
"shape":"String",
"documentation":"<p> If the result of the previous request to DetectEntities was truncated, include the Paginationtoken to fetch the next page of entities.</p>"
"documentation":"<p> If the result of the previous request to <code>DetectEntities</code> was truncated, include the <code>PaginationToken</code> to fetch the next page of entities.</p>"
},
"ModelVersion":{
"shape":"String",
"documentation":"<p>The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.</p>"
}
}
},
"DetectEntitiesV2Request":{
"type":"structure",
"required":["Text"],
"members":{
"Text":{
"shape":"BoundedLengthString",
"documentation":"<p>A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.</p>"
}
}
},
"DetectEntitiesV2Response":{
"type":"structure",
"required":[
"Entities",
"ModelVersion"
],
"members":{
"Entities":{
"shape":"EntityList",
"documentation":"<p>The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.</p>"
},
"UnmappedAttributes":{
"shape":"UnmappedAttributeList",
"documentation":"<p>Attributes extracted from the input text that couldn't be related to an entity.</p>"
},
"PaginationToken":{
"shape":"String",
"documentation":"<p>If the result to the <code>DetectEntitiesV2</code> operation was truncated, include the <code>PaginationToken</code> to fetch the next page of entities.</p>"
},
"ModelVersion":{
"shape":"String",
"documentation":"<p>The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.</p>"
}
}
},
@ -148,15 +469,22 @@
},
"DetectPHIResponse":{
"type":"structure",
"required":["Entities"],
"required":[
"Entities",
"ModelVersion"
],
"members":{
"Entities":{
"shape":"EntityList",
"documentation":"<p> The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in its detection. </p>"
"documentation":"<p> The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection. </p>"
},
"PaginationToken":{
"shape":"String",
"documentation":"<p> If the result of the previous request to DetectPHI was truncated, include the Paginationtoken to fetch the next page of PHI entities. </p>"
"documentation":"<p> If the result of the previous request to <code>DetectPHI</code> was truncated, include the <code>PaginationToken</code> to fetch the next page of PHI entities. </p>"
},
"ModelVersion":{
"shape":"String",
"documentation":"<p>The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.</p>"
}
}
},
@ -177,7 +505,7 @@
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Comprehend Medical has in the accuracy of the detection.</p>"
"documentation":"<p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.</p>"
},
"Text":{
"shape":"String",
@ -250,6 +578,27 @@
]
},
"Float":{"type":"float"},
"IamRoleArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+"
},
"InputDataConfig":{
"type":"structure",
"required":["S3Bucket"],
"members":{
"S3Bucket":{
"shape":"S3Bucket",
"documentation":"<p>The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.</p> <p>Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.</p>"
},
"S3Key":{
"shape":"S3Key",
"documentation":"<p>The path to the input data files in the S3 bucket.</p>"
}
},
"documentation":"<p>The input properties for an entities detection job</p>"
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
@ -276,14 +625,289 @@
"documentation":"<p> The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.</p>",
"exception":true
},
"JobId":{
"type":"string",
"max":32,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
},
"JobName":{
"type":"string",
"max":256,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
},
"JobStatus":{
"type":"string",
"enum":[
"SUBMITTED",
"IN_PROGRESS",
"COMPLETED",
"PARTIAL_SUCCESS",
"FAILED",
"STOP_REQUESTED",
"STOPPED"
]
},
"KMSKey":{
"type":"string",
"max":2048,
"min":1,
"pattern":".*"
},
"LanguageCode":{
"type":"string",
"enum":["en"]
},
"ListEntitiesDetectionV2JobsRequest":{
"type":"structure",
"members":{
"Filter":{
"shape":"ComprehendMedicalAsyncJobFilter",
"documentation":"<p>Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
}
}
},
"ListEntitiesDetectionV2JobsResponse":{
"type":"structure",
"members":{
"ComprehendMedicalAsyncJobPropertiesList":{
"shape":"ComprehendMedicalAsyncJobPropertiesList",
"documentation":"<p>A list containing the properties of each job returned.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
}
}
},
"ListPHIDetectionJobsRequest":{
"type":"structure",
"members":{
"Filter":{
"shape":"ComprehendMedicalAsyncJobFilter",
"documentation":"<p>Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
},
"MaxResults":{
"shape":"MaxResultsInteger",
"documentation":"<p>The maximum number of results to return in each page. The default is 100.</p>"
}
}
},
"ListPHIDetectionJobsResponse":{
"type":"structure",
"members":{
"ComprehendMedicalAsyncJobPropertiesList":{
"shape":"ComprehendMedicalAsyncJobPropertiesList",
"documentation":"<p>A list containing the properties of each job returned.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>Identifies the next page of results to return.</p>"
}
}
},
"ManifestFilePath":{
"type":"string",
"max":4096,
"min":1
},
"MaxResultsInteger":{
"type":"integer",
"max":500,
"min":1
},
"ModelVersion":{"type":"string"},
"OutputDataConfig":{
"type":"structure",
"required":["S3Bucket"],
"members":{
"S3Bucket":{
"shape":"S3Bucket",
"documentation":"<p>When you use the <code>OutputDataConfig</code> object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.</p>"
},
"S3Key":{
"shape":"S3Key",
"documentation":"<p>The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.</p>"
}
},
"documentation":"<p>The output properties for a detection job.</p>"
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.</p>",
"exception":true
},
"S3Bucket":{
"type":"string",
"max":63,
"min":3,
"pattern":"^[0-9a-z\\.\\-_]*(?!\\.)$"
},
"S3Key":{
"type":"string",
"max":1024,
"pattern":".*"
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p> The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request. </p>",
"documentation":"<p> The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request. </p>",
"exception":true
},
"StartEntitiesDetectionV2JobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"LanguageCode"
],
"members":{
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Specifies the format and location of the input data for the job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>Specifies where to send the output files.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med\"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The identifier of the job.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestTokenString",
"documentation":"<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.</p>",
"idempotencyToken":true
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. All documents must be in the same language.</p>"
}
}
},
"StartEntitiesDetectionV2JobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier generated for the job. To get the status of a job, use this identifier with the <code>DescribeEntitiesDetectionV2Job</code> operation.</p>"
}
}
},
"StartPHIDetectionJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn",
"LanguageCode"
],
"members":{
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Specifies the format and location of the input data for the job.</p>"
},
"OutputDataConfig":{
"shape":"OutputDataConfig",
"documentation":"<p>Specifies where to send the output files.</p>"
},
"DataAccessRoleArn":{
"shape":"IamRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med\"> Role-Based Permissions Required for Asynchronous Operations</a>.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The identifier of the job.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestTokenString",
"documentation":"<p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.</p>",
"idempotencyToken":true
},
"KMSKey":{
"shape":"KMSKey",
"documentation":"<p>An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents. All documents must be in the same language.</p>"
}
}
},
"StartPHIDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier generated for the job. To get the status of a job, use this identifier with the <code>DescribePHIDetectionJob</code> operation.</p>"
}
}
},
"StopEntitiesDetectionV2JobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the medical entities job to stop.</p>"
}
}
},
"StopEntitiesDetectionV2JobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the medical entities detection job that was stopped.</p>"
}
}
},
"StopPHIDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the PHI detection job to stop.</p>"
}
}
},
"StopPHIDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier of the PHI detection job that was stopped.</p>"
}
}
},
"String":{
"type":"string",
"min":1
@ -296,6 +920,7 @@
"documentation":"<p> The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request. </p>",
"exception":true
},
"Timestamp":{"type":"timestamp"},
"TooManyRequestsException":{
"type":"structure",
"members":{
@ -313,7 +938,7 @@
},
"Score":{
"shape":"Float",
"documentation":"<p> The level of confidence that Comprehend Medical has in the accuracy of this trait.</p>"
"documentation":"<p> The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.</p>"
}
},
"documentation":"<p> Provides contextual information about the extracted entity. </p>"
@ -327,7 +952,7 @@
"members":{
"Type":{
"shape":"EntityType",
"documentation":"<p> The type of the attribute, could be one of the following values: \"MEDICATION\", \"MEDICAL_CONDITION\", \"ANATOMY\", \"TEST_AND_TREATMENT_PROCEDURE\" or \"PERSONAL_HEALTH_INFORMATION\". </p>"
"documentation":"<p> The type of the attribute, could be one of the following values: \"MEDICATION\", \"MEDICAL_CONDITION\", \"ANATOMY\", \"TEST_AND_TREATMENT_PROCEDURE\" or \"PROTECTED_HEALTH_INFORMATION\". </p>"
},
"Attribute":{
"shape":"Attribute",
@ -339,7 +964,15 @@
"UnmappedAttributeList":{
"type":"list",
"member":{"shape":"UnmappedAttribute"}
},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.</p>",
"exception":true
}
},
"documentation":"<p> Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. </p>"
"documentation":"<p> Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. </p>"
}

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

@ -128,7 +128,8 @@
{"shape":"NoSuchOrganizationConfigRuleException"},
{"shape":"ResourceInUseException"},
{"shape":"OrganizationAccessDeniedException"}
]
],
"documentation":"<p>Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization. Only a master account can delete an organization config rule.</p> <p>AWS Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.</p>"
},
"DeletePendingAggregationRequest":{
"name":"DeletePendingAggregationRequest",
@ -156,6 +157,19 @@
],
"documentation":"<p>Deletes the remediation configuration.</p>"
},
"DeleteRemediationExceptions":{
"name":"DeleteRemediationExceptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteRemediationExceptionsRequest"},
"output":{"shape":"DeleteRemediationExceptionsResponse"},
"errors":[
{"shape":"NoSuchRemediationExceptionException"}
],
"documentation":"<p>Deletes one or more remediation exceptions mentioned in the resource keys.</p>"
},
"DeleteRetentionConfiguration":{
"name":"DeleteRetentionConfiguration",
"http":{
@ -198,7 +212,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"NoSuchConfigurationAggregatorException"}
],
"documentation":"<p>Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. </p> <note> <p>The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.</p> </note>"
"documentation":"<p>Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. </p> <note> <p>The results can return an empty result page, but if you have a <code>nextToken</code>, the results are displayed on the next page.</p> </note>"
},
"DescribeAggregationAuthorizations":{
"name":"DescribeAggregationAuthorizations",
@ -370,7 +384,8 @@
{"shape":"InvalidLimitException"},
{"shape":"InvalidNextTokenException"},
{"shape":"OrganizationAccessDeniedException"}
]
],
"documentation":"<p>Provides organization config rule deployment status for an organization.</p> <note> <p>The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.</p> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.</p> <p>Only a master account can call this API.</p> </note>"
},
"DescribeOrganizationConfigRules":{
"name":"DescribeOrganizationConfigRules",
@ -385,7 +400,8 @@
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidLimitException"},
{"shape":"OrganizationAccessDeniedException"}
]
],
"documentation":"<p>Returns a list of organization config rules.</p> <note> <p>When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.</p> <p>Only a master account can call this API.</p> </note>"
},
"DescribePendingAggregationRequests":{
"name":"DescribePendingAggregationRequests",
@ -412,6 +428,20 @@
"output":{"shape":"DescribeRemediationConfigurationsResponse"},
"documentation":"<p>Returns the details of one or more remediation configurations.</p>"
},
"DescribeRemediationExceptions":{
"name":"DescribeRemediationExceptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeRemediationExceptionsRequest"},
"output":{"shape":"DescribeRemediationExceptionsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterValueException"}
],
"documentation":"<p>Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response. </p> <note> <p>When you specify the limit and the next token, you receive a paginated response. </p> <p>Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.</p> </note>"
},
"DescribeRemediationExecutionStatus":{
"name":"DescribeRemediationExecutionStatus",
"http":{
@ -421,7 +451,8 @@
"input":{"shape":"DescribeRemediationExecutionStatusRequest"},
"output":{"shape":"DescribeRemediationExecutionStatusResponse"},
"errors":[
{"shape":"NoSuchRemediationConfigurationException"}
{"shape":"NoSuchRemediationConfigurationException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.</p>"
},
@ -454,7 +485,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"NoSuchConfigurationAggregatorException"}
],
"documentation":"<p>Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </p> <note> <p>The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.</p> </note>"
"documentation":"<p>Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. </p> <note> <p>The results can return an empty result page. But if you have a <code>nextToken</code>, the results are displayed on the next page.</p> </note>"
},
"GetAggregateConfigRuleComplianceSummary":{
"name":"GetAggregateConfigRuleComplianceSummary",
@ -582,7 +613,8 @@
{"shape":"InvalidLimitException"},
{"shape":"InvalidNextTokenException"},
{"shape":"OrganizationAccessDeniedException"}
]
],
"documentation":"<p>Returns detailed status for each member account within an organization for a given organization config rule.</p> <note> <p>Only a master account can call this API.</p> </note>"
},
"GetResourceConfigHistory":{
"name":"GetResourceConfigHistory",
@ -762,7 +794,8 @@
{"shape":"NoAvailableOrganizationException"},
{"shape":"OrganizationAllFeaturesNotEnabledException"},
{"shape":"InsufficientPermissionsException"}
]
],
"documentation":"<p>Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations. Only a master account can create or update an organization config rule.</p> <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master account of your organization. The service linked role is created only when the role does not exist in the master account. AWS Config verifies the existence of role with <code>GetRole</code> action.</p> <p>You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account that the rule invokes to evaluate your resources. When you use the <code>PutOrganizationConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the <code>RuleIdentifier</code> key.</p> <p>The maximum number of organization config rules that AWS Config supports is 150.</p> <note> <p>Specify either <code>OrganizationCustomRuleMetadata</code> or <code>OrganizationManagedRuleMetadata</code>.</p> </note>"
},
"PutRemediationConfigurations":{
"name":"PutRemediationConfigurations",
@ -778,6 +811,19 @@
],
"documentation":"<p>Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the <code>RemediationConfiguration</code> object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. </p>"
},
"PutRemediationExceptions":{
"name":"PutRemediationExceptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutRemediationExceptionsRequest"},
"output":{"shape":"PutRemediationExceptionsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"}
],
"documentation":"<p>A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule. </p>"
},
"PutRetentionConfiguration":{
"name":"PutRetentionConfiguration",
"http":{
@ -845,6 +891,7 @@
"input":{"shape":"StartRemediationExecutionRequest"},
"output":{"shape":"StartRemediationExecutionResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"InsufficientPermissionsException"},
{"shape":"NoSuchRemediationConfigurationException"}
],
@ -1135,6 +1182,18 @@
"max":256,
"min":1
},
"AutoRemediationAttemptSeconds":{
"type":"long",
"box":true,
"max":2678000,
"min":1
},
"AutoRemediationAttempts":{
"type":"integer",
"box":true,
"max":25,
"min":1
},
"AvailabilityZone":{"type":"string"},
"AwsRegion":{
"type":"string",
@ -1579,12 +1638,13 @@
},
"ConfigRuleName":{
"type":"string",
"max":64,
"min":1
"max":128,
"min":1,
"pattern":".*\\S.*"
},
"ConfigRuleNames":{
"type":"list",
"member":{"shape":"StringWithCharLimit64"},
"member":{"shape":"ConfigRuleName"},
"max":25,
"min":0
},
@ -1934,7 +1994,10 @@
"type":"structure",
"required":["OrganizationConfigRuleName"],
"members":{
"OrganizationConfigRuleName":{"shape":"StringWithCharLimit64"}
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
"documentation":"<p>The name of organization config rule that you want to delete.</p>"
}
}
},
"DeletePendingAggregationRequestRequest":{
@ -1959,7 +2022,7 @@
"required":["ConfigRuleName"],
"members":{
"ConfigRuleName":{
"shape":"StringWithCharLimit64",
"shape":"ConfigRuleName",
"documentation":"<p>The name of the AWS Config rule for which you want to delete remediation configuration.</p>"
},
"ResourceType":{
@ -1973,6 +2036,32 @@
"members":{
}
},
"DeleteRemediationExceptionsRequest":{
"type":"structure",
"required":[
"ConfigRuleName",
"ResourceKeys"
],
"members":{
"ConfigRuleName":{
"shape":"ConfigRuleName",
"documentation":"<p>The name of the AWS Config rule for which you want to delete remediation exception configuration.</p>"
},
"ResourceKeys":{
"shape":"RemediationExceptionResourceKeys",
"documentation":"<p>An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys. </p>"
}
}
},
"DeleteRemediationExceptionsResponse":{
"type":"structure",
"members":{
"FailedBatches":{
"shape":"FailedDeleteRemediationExceptionsBatches",
"documentation":"<p>Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.</p>"
}
}
},
"DeleteRetentionConfigurationRequest":{
"type":"structure",
"required":["RetentionConfigurationName"],
@ -2090,7 +2179,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2103,7 +2192,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2116,7 +2205,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2129,7 +2218,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2279,7 +2368,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
},
"Limit":{
"shape":"Limit",
@ -2296,7 +2385,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2309,7 +2398,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
},
"Limit":{
"shape":"Limit",
@ -2326,7 +2415,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2413,31 +2502,61 @@
"DescribeOrganizationConfigRuleStatusesRequest":{
"type":"structure",
"members":{
"OrganizationConfigRuleNames":{"shape":"OrganizationConfigRuleNames"},
"Limit":{"shape":"CosmosPageLimit"},
"NextToken":{"shape":"String"}
"OrganizationConfigRuleNames":{
"shape":"OrganizationConfigRuleNames",
"documentation":"<p>The names of organization config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg rules.</p>"
},
"Limit":{
"shape":"CosmosPageLimit",
"documentation":"<p>The maximum number of <code>OrganizationConfigRuleStatuses</code> returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"DescribeOrganizationConfigRuleStatusesResponse":{
"type":"structure",
"members":{
"OrganizationConfigRuleStatuses":{"shape":"OrganizationConfigRuleStatuses"},
"NextToken":{"shape":"String"}
"OrganizationConfigRuleStatuses":{
"shape":"OrganizationConfigRuleStatuses",
"documentation":"<p>A list of <code>OrganizationConfigRuleStatus</code> objects.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"DescribeOrganizationConfigRulesRequest":{
"type":"structure",
"members":{
"OrganizationConfigRuleNames":{"shape":"OrganizationConfigRuleNames"},
"Limit":{"shape":"CosmosPageLimit"},
"NextToken":{"shape":"String"}
"OrganizationConfigRuleNames":{
"shape":"OrganizationConfigRuleNames",
"documentation":"<p>The names of organization config rules for which you want details. If you do not specify any names, AWS Config returns details for all your organization config rules.</p>"
},
"Limit":{
"shape":"CosmosPageLimit",
"documentation":"<p>The maximum number of organization config rules returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"DescribeOrganizationConfigRulesResponse":{
"type":"structure",
"members":{
"OrganizationConfigRules":{"shape":"OrganizationConfigRules"},
"NextToken":{"shape":"String"}
"OrganizationConfigRules":{
"shape":"OrganizationConfigRules",
"documentation":"<p>Retuns a list <code>OrganizationConfigRule</code> objects.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"DescribePendingAggregationRequestsLimit":{
@ -2454,7 +2573,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2467,7 +2586,7 @@
},
"NextToken":{
"shape":"String",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2490,12 +2609,47 @@
}
}
},
"DescribeRemediationExceptionsRequest":{
"type":"structure",
"required":["ConfigRuleName"],
"members":{
"ConfigRuleName":{
"shape":"ConfigRuleName",
"documentation":"<p>The name of the AWS Config rule.</p>"
},
"ResourceKeys":{
"shape":"RemediationExceptionResourceKeys",
"documentation":"<p>An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys. </p>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, AWS Config uses the default.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>"
}
}
},
"DescribeRemediationExceptionsResponse":{
"type":"structure",
"members":{
"RemediationExceptions":{
"shape":"RemediationExceptions",
"documentation":"<p>Returns a list of remediation exception objects.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>"
}
}
},
"DescribeRemediationExecutionStatusRequest":{
"type":"structure",
"required":["ConfigRuleName"],
"members":{
"ConfigRuleName":{
"shape":"StringWithCharLimit64",
"shape":"ConfigRuleName",
"documentation":"<p>A list of AWS Config rule names.</p>"
},
"ResourceKeys":{
@ -2507,7 +2661,7 @@
"documentation":"<p>The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, AWS Config uses the default. </p>"
},
"NextToken":{
"shape":"StringWithCharLimit256",
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
@ -2520,7 +2674,7 @@
"documentation":"<p>Returns a list of remediation execution statuses objects.</p>"
},
"NextToken":{
"shape":"StringWithCharLimit256",
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
@ -2675,11 +2829,39 @@
"max":1000,
"min":0
},
"ExecutionControls":{
"type":"structure",
"members":{
"SsmControls":{
"shape":"SsmControls",
"documentation":"<p>A SsmControls object.</p>"
}
},
"documentation":"<p>The controls that AWS Config uses for executing remediations.</p>"
},
"Expression":{
"type":"string",
"max":4096,
"min":1
},
"FailedDeleteRemediationExceptionsBatch":{
"type":"structure",
"members":{
"FailureMessage":{
"shape":"String",
"documentation":"<p>Returns a failure message for delete remediation exception. For example, AWS Config creates an exception due to an internal error.</p>"
},
"FailedItems":{
"shape":"RemediationExceptionResourceKeys",
"documentation":"<p>Returns remediation exception resource key object of the failed items.</p>"
}
},
"documentation":"<p>List of each of the failed delete remediation exceptions with specific reasons.</p>"
},
"FailedDeleteRemediationExceptionsBatches":{
"type":"list",
"member":{"shape":"FailedDeleteRemediationExceptionsBatch"}
},
"FailedRemediationBatch":{
"type":"structure",
"members":{
@ -2698,6 +2880,24 @@
"type":"list",
"member":{"shape":"FailedRemediationBatch"}
},
"FailedRemediationExceptionBatch":{
"type":"structure",
"members":{
"FailureMessage":{
"shape":"String",
"documentation":"<p>Returns a failure message. For example, the auto-remediation has failed.</p>"
},
"FailedItems":{
"shape":"RemediationExceptions",
"documentation":"<p>Returns remediation exception resource key object of the failed items.</p>"
}
},
"documentation":"<p>List of each of the failed remediation exceptions with specific reasons.</p>"
},
"FailedRemediationExceptionBatches":{
"type":"list",
"member":{"shape":"FailedRemediationExceptionBatch"}
},
"FieldInfo":{
"type":"structure",
"members":{
@ -2748,7 +2948,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2761,7 +2961,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2787,7 +2987,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -2804,7 +3004,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>"
}
}
},
@ -3027,17 +3227,35 @@
"type":"structure",
"required":["OrganizationConfigRuleName"],
"members":{
"OrganizationConfigRuleName":{"shape":"StringWithCharLimit64"},
"Filters":{"shape":"StatusDetailFilters"},
"Limit":{"shape":"CosmosPageLimit"},
"NextToken":{"shape":"String"}
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
"documentation":"<p>The name of organization config rule for which you want status details for member accounts.</p>"
},
"Filters":{
"shape":"StatusDetailFilters",
"documentation":"<p>A <code>StatusDetailFilters</code> object.</p>"
},
"Limit":{
"shape":"CosmosPageLimit",
"documentation":"<p>The maximum number of <code>OrganizationConfigRuleDetailedStatus</code> returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"GetOrganizationConfigRuleDetailedStatusResponse":{
"type":"structure",
"members":{
"OrganizationConfigRuleDetailedStatus":{"shape":"OrganizationConfigRuleDetailedStatus"},
"NextToken":{"shape":"String"}
"OrganizationConfigRuleDetailedStatus":{
"shape":"OrganizationConfigRuleDetailedStatus",
"documentation":"<p>A list of <code>MemberAccountStatus</code> objects.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
"GetResourceConfigHistoryRequest":{
@ -3131,7 +3349,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>Indicates one of the following errors:</p> <ul> <li> <p>The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</p> </li> <li> <p>The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</p> </li> </ul>",
"documentation":"<p>Indicates one of the following errors:</p> <ul> <li> <p>For PutConfigRule, the rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.</p> </li> <li> <p>For PutConfigRule, the AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</p> </li> <li> <p>For OrganizationConfigRule, organization config rule cannot be created because you do not have permissions to call IAM <code>GetRole</code> action or create service linked role.</p> </li> </ul>",
"exception":true
},
"Integer":{"type":"integer"},
@ -3340,7 +3558,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
@ -3353,7 +3571,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
"documentation":"<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response. </p>"
}
}
},
@ -3383,6 +3601,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>You have reached the limit of the number of organization config rules you can create.</p>",
"exception":true
},
"MaxNumberOfRetentionConfigurationsExceededException":{
@ -3424,13 +3643,32 @@
"MemberAccountRuleStatus"
],
"members":{
"AccountId":{"shape":"AccountId"},
"ConfigRuleName":{"shape":"StringWithCharLimit64"},
"MemberAccountRuleStatus":{"shape":"MemberAccountRuleStatus"},
"ErrorCode":{"shape":"String"},
"ErrorMessage":{"shape":"String"},
"LastUpdateTime":{"shape":"Date"}
}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The 12-digit account ID of a member account.</p>"
},
"ConfigRuleName":{
"shape":"StringWithCharLimit64",
"documentation":"<p>The name of config rule deployed in the member account.</p>"
},
"MemberAccountRuleStatus":{
"shape":"MemberAccountRuleStatus",
"documentation":"<p>Indicates deployment status for config rule in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the first time, config rule status is created in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes <code>OrganizationConfigRule</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p> AWS Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when config rule has been created in the member account. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when config rule is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when config rule creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when config rule is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when config rule has been deleted in the member account. </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when config rule has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when config rule is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> </ul>"
},
"ErrorCode":{
"shape":"String",
"documentation":"<p>An error code that is returned when config rule creation or deletion failed in the member account.</p>"
},
"ErrorMessage":{
"shape":"String",
"documentation":"<p>An error message indicating that config rule account creation or deletion has failed due to an error in the member account.</p>"
},
"LastUpdateTime":{
"shape":"Date",
"documentation":"<p>The timestamp of the last status update.</p>"
}
},
"documentation":"<p>Organization config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.</p>"
},
"MessageType":{
"type":"string",
@ -3461,7 +3699,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>Organization does is no longer available.</p>",
"documentation":"<p>Organization is no longer available.</p>",
"exception":true
},
"NoRunningConfigurationRecorderException":{
@ -3510,6 +3748,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>You specified one or more organization config rules that do not exist.</p>",
"exception":true
},
"NoSuchRemediationConfigurationException":{
@ -3519,6 +3758,13 @@
"documentation":"<p>You specified an AWS Config rule without a remediation configuration.</p>",
"exception":true
},
"NoSuchRemediationExceptionException":{
"type":"structure",
"members":{
},
"documentation":"<p>You tried to delete a remediation exception that does not exist.</p>",
"exception":true
},
"NoSuchRetentionConfigurationException":{
"type":"structure",
"members":{
@ -3531,7 +3777,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>No permission to call the EnableAWSServiceAccess API.</p>",
"documentation":"<p>For PutConfigAggregator API, no permission to call EnableAWSServiceAccess API.</p> <p>For all OrganizationConfigRule APIs, AWS Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.</p>",
"exception":true
},
"OrganizationAggregationSource":{
@ -3557,7 +3803,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The configuration aggregator cannot be created because organization does not have all features enabled.</p>",
"documentation":"<p>AWS Config resource cannot be created because your organization does not have all features enabled.</p>",
"exception":true
},
"OrganizationConfigRule":{
@ -3567,18 +3813,43 @@
"OrganizationConfigRuleArn"
],
"members":{
"OrganizationConfigRuleName":{"shape":"StringWithCharLimit64"},
"OrganizationConfigRuleArn":{"shape":"StringWithCharLimit256"},
"OrganizationManagedRuleMetadata":{"shape":"OrganizationManagedRuleMetadata"},
"OrganizationCustomRuleMetadata":{"shape":"OrganizationCustomRuleMetadata"},
"ExcludedAccounts":{"shape":"ExcludedAccounts"},
"LastUpdateTime":{"shape":"Date"}
}
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
"documentation":"<p>The name that you assign to organization config rule.</p>"
},
"OrganizationConfigRuleArn":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The Amazon Resource Name (ARN) of organization config rule.</p>"
},
"OrganizationManagedRuleMetadata":{
"shape":"OrganizationManagedRuleMetadata",
"documentation":"<p>An <code>OrganizationManagedRuleMetadata</code> object.</p>"
},
"OrganizationCustomRuleMetadata":{
"shape":"OrganizationCustomRuleMetadata",
"documentation":"<p>An <code>OrganizationCustomRuleMetadata</code> object.</p>"
},
"ExcludedAccounts":{
"shape":"ExcludedAccounts",
"documentation":"<p>A comma-separated list of accounts excluded from organization config rule.</p>"
},
"LastUpdateTime":{
"shape":"Date",
"documentation":"<p>The timestamp of the last update.</p>"
}
},
"documentation":"<p>An organization config rule that has information about config rules that AWS Config creates in member accounts.</p>"
},
"OrganizationConfigRuleDetailedStatus":{
"type":"list",
"member":{"shape":"MemberAccountStatus"}
},
"OrganizationConfigRuleName":{
"type":"string",
"max":64,
"min":1,
"pattern":".*\\S.*"
},
"OrganizationConfigRuleNames":{
"type":"list",
"member":{"shape":"StringWithCharLimit64"},
@ -3592,12 +3863,28 @@
"OrganizationRuleStatus"
],
"members":{
"OrganizationConfigRuleName":{"shape":"StringWithCharLimit64"},
"OrganizationRuleStatus":{"shape":"OrganizationRuleStatus"},
"ErrorCode":{"shape":"String"},
"ErrorMessage":{"shape":"String"},
"LastUpdateTime":{"shape":"Date"}
}
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
"documentation":"<p>The name that you assign to organization config rule.</p>"
},
"OrganizationRuleStatus":{
"shape":"OrganizationRuleStatus",
"documentation":"<p>Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in all the member accounts. Additionally, config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>.</p> <p>AWS Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when an organization config rule has been successfully created in all the member accounts. </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when an organization config rule creation is in progress.</p> </li> <li> <p> <code>CREATE_FAILED</code> when an organization config rule creation failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_FAILED</code> when an organization config rule deletion failed in one or more member accounts within that organization.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when an organization config rule deletion is in progress.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when an organization config rule has been successfully deleted from all the member accounts.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when an organization config rule has been successfully updated in all the member accounts.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when an organization config rule update is in progress.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when an organization config rule update failed in one or more member accounts within that organization.</p> </li> </ul>"
},
"ErrorCode":{
"shape":"String",
"documentation":"<p>An error code that is returned when organization config rule creation or deletion has failed.</p>"
},
"ErrorMessage":{
"shape":"String",
"documentation":"<p>An error message indicating that organization config rule creation or deletion failed due to an error.</p>"
},
"LastUpdateTime":{
"shape":"Date",
"documentation":"<p>The timestamp of the last update.</p>"
}
},
"documentation":"<p>Returns the status for an organization config rule in an organization.</p>"
},
"OrganizationConfigRuleStatuses":{
"type":"list",
@ -3626,30 +3913,83 @@
"OrganizationConfigRuleTriggerTypes"
],
"members":{
"Description":{"shape":"StringWithCharLimit256Min0"},
"LambdaFunctionArn":{"shape":"StringWithCharLimit256"},
"OrganizationConfigRuleTriggerTypes":{"shape":"OrganizationConfigRuleTriggerTypes"},
"InputParameters":{"shape":"StringWithCharLimit2048"},
"MaximumExecutionFrequency":{"shape":"MaximumExecutionFrequency"},
"ResourceTypesScope":{"shape":"ResourceTypesScope"},
"ResourceIdScope":{"shape":"StringWithCharLimit768"},
"TagKeyScope":{"shape":"StringWithCharLimit128"},
"TagValueScope":{"shape":"StringWithCharLimit256"}
}
"Description":{
"shape":"StringWithCharLimit256Min0",
"documentation":"<p>The description that you provide for organization config rule.</p>"
},
"LambdaFunctionArn":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The lambda function ARN.</p>"
},
"OrganizationConfigRuleTriggerTypes":{
"shape":"OrganizationConfigRuleTriggerTypes",
"documentation":"<p>The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:</p> <ul> <li> <p> <code>ConfigurationItemChangeNotification</code> - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.</p> </li> <li> <p> <code>OversizedConfigurationItemChangeNotification</code> - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.</p> </li> <li> <p> <code>ScheduledNotification</code> - Triggers a periodic evaluation at the frequency specified for <code>MaximumExecutionFrequency</code>.</p> </li> </ul>"
},
"InputParameters":{
"shape":"StringWithCharLimit2048",
"documentation":"<p>A string, in JSON format, that is passed to organization config rule Lambda function.</p>"
},
"MaximumExecutionFrequency":{
"shape":"MaximumExecutionFrequency",
"documentation":"<p>The maximum frequency with which AWS Config runs evaluations for a rule. Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> </note>"
},
"ResourceTypesScope":{
"shape":"ResourceTypesScope",
"documentation":"<p>The type of the AWS resource that was evaluated.</p>"
},
"ResourceIdScope":{
"shape":"StringWithCharLimit768",
"documentation":"<p>The ID of the AWS resource that was evaluated.</p>"
},
"TagKeyScope":{
"shape":"StringWithCharLimit128",
"documentation":"<p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. </p>"
},
"TagValueScope":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). </p>"
}
},
"documentation":"<p>An object that specifies organization custom rule metadata such as resource type, resource ID of AWS resource, Lamdba function ARN, and organization trigger types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.</p>"
},
"OrganizationManagedRuleMetadata":{
"type":"structure",
"required":["RuleIdentifier"],
"members":{
"Description":{"shape":"StringWithCharLimit256Min0"},
"RuleIdentifier":{"shape":"StringWithCharLimit256"},
"InputParameters":{"shape":"StringWithCharLimit2048"},
"MaximumExecutionFrequency":{"shape":"MaximumExecutionFrequency"},
"ResourceTypesScope":{"shape":"ResourceTypesScope"},
"ResourceIdScope":{"shape":"StringWithCharLimit768"},
"TagKeyScope":{"shape":"StringWithCharLimit128"},
"TagValueScope":{"shape":"StringWithCharLimit256"}
}
"Description":{
"shape":"StringWithCharLimit256Min0",
"documentation":"<p>The description that you provide for organization config rule.</p>"
},
"RuleIdentifier":{
"shape":"StringWithCharLimit256",
"documentation":"<p>For organization config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p>"
},
"InputParameters":{
"shape":"StringWithCharLimit2048",
"documentation":"<p>A string, in JSON format, that is passed to organization config rule Lambda function.</p>"
},
"MaximumExecutionFrequency":{
"shape":"MaximumExecutionFrequency",
"documentation":"<p>The maximum frequency with which AWS Config runs evaluations for a rule. You are using an AWS managed rule that is triggered at a periodic frequency.</p> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> </note>"
},
"ResourceTypesScope":{
"shape":"ResourceTypesScope",
"documentation":"<p>The type of the AWS resource that was evaluated.</p>"
},
"ResourceIdScope":{
"shape":"StringWithCharLimit768",
"documentation":"<p>The ID of the AWS resource that was evaluated.</p>"
},
"TagKeyScope":{
"shape":"StringWithCharLimit128",
"documentation":"<p>One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values. </p>"
},
"TagValueScope":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).</p>"
}
},
"documentation":"<p>An object that specifies organization managed rule metadata such as resource type and ID of AWS resource along with the rule identifier. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.</p>"
},
"OrganizationRuleStatus":{
"type":"string",
@ -3697,6 +4037,12 @@
"type":"list",
"member":{"shape":"PendingAggregationRequest"}
},
"Percentage":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"PutAggregationAuthorizationRequest":{
"type":"structure",
"required":[
@ -3712,7 +4058,10 @@
"shape":"AwsRegion",
"documentation":"<p>The region authorized to collect aggregated data.</p>"
},
"Tags":{"shape":"TagsList"}
"Tags":{
"shape":"TagsList",
"documentation":"<p>An array of tag object.</p>"
}
}
},
"PutAggregationAuthorizationResponse":{
@ -3732,7 +4081,10 @@
"shape":"ConfigRule",
"documentation":"<p>The rule that you want to add to your account.</p>"
},
"Tags":{"shape":"TagsList"}
"Tags":{
"shape":"TagsList",
"documentation":"<p>An array of tag object.</p>"
}
}
},
"PutConfigurationAggregatorRequest":{
@ -3751,7 +4103,10 @@
"shape":"OrganizationAggregationSource",
"documentation":"<p>An OrganizationAggregationSource object.</p>"
},
"Tags":{"shape":"TagsList"}
"Tags":{
"shape":"TagsList",
"documentation":"<p>An array of tag object.</p>"
}
}
},
"PutConfigurationAggregatorResponse":{
@ -3818,16 +4173,31 @@
"type":"structure",
"required":["OrganizationConfigRuleName"],
"members":{
"OrganizationConfigRuleName":{"shape":"StringWithCharLimit64"},
"OrganizationManagedRuleMetadata":{"shape":"OrganizationManagedRuleMetadata"},
"OrganizationCustomRuleMetadata":{"shape":"OrganizationCustomRuleMetadata"},
"ExcludedAccounts":{"shape":"ExcludedAccounts"}
"OrganizationConfigRuleName":{
"shape":"OrganizationConfigRuleName",
"documentation":"<p>The name that you assign to an organization config rule.</p>"
},
"OrganizationManagedRuleMetadata":{
"shape":"OrganizationManagedRuleMetadata",
"documentation":"<p>An <code>OrganizationManagedRuleMetadata</code> object. </p>"
},
"OrganizationCustomRuleMetadata":{
"shape":"OrganizationCustomRuleMetadata",
"documentation":"<p>An <code>OrganizationCustomRuleMetadata</code> object.</p>"
},
"ExcludedAccounts":{
"shape":"ExcludedAccounts",
"documentation":"<p>A comma-separated list of accounts that you want to exclude from an organization config rule.</p>"
}
}
},
"PutOrganizationConfigRuleResponse":{
"type":"structure",
"members":{
"OrganizationConfigRuleArn":{"shape":"StringWithCharLimit256"}
"OrganizationConfigRuleArn":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The Amazon Resource Name (ARN) of an organization config rule.</p>"
}
}
},
"PutRemediationConfigurationsRequest":{
@ -3849,6 +4219,40 @@
}
}
},
"PutRemediationExceptionsRequest":{
"type":"structure",
"required":[
"ConfigRuleName",
"ResourceKeys"
],
"members":{
"ConfigRuleName":{
"shape":"ConfigRuleName",
"documentation":"<p>The name of the AWS Config rule for which you want to create remediation exception.</p>"
},
"ResourceKeys":{
"shape":"RemediationExceptionResourceKeys",
"documentation":"<p>An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys. </p>"
},
"Message":{
"shape":"StringWithCharLimit1024",
"documentation":"<p>The message contains an explanation of the exception.</p>"
},
"ExpirationTime":{
"shape":"Date",
"documentation":"<p>The exception is automatically deleted after the expiration date.</p>"
}
}
},
"PutRemediationExceptionsResponse":{
"type":"structure",
"members":{
"FailedBatches":{
"shape":"FailedRemediationExceptionBatches",
"documentation":"<p>Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.</p>"
}
}
},
"PutRetentionConfigurationRequest":{
"type":"structure",
"required":["RetentionPeriodInDays"],
@ -3956,7 +4360,7 @@
],
"members":{
"ConfigRuleName":{
"shape":"StringWithCharLimit64",
"shape":"ConfigRuleName",
"documentation":"<p>The name of the AWS Config rule.</p>"
},
"TargetType":{
@ -3978,6 +4382,30 @@
"ResourceType":{
"shape":"String",
"documentation":"<p>The type of a resource. </p>"
},
"Automatic":{
"shape":"Boolean",
"documentation":"<p>The remediation is triggered automatically.</p>"
},
"ExecutionControls":{
"shape":"ExecutionControls",
"documentation":"<p>An ExecutionControls object.</p>"
},
"MaximumAutomaticAttempts":{
"shape":"AutoRemediationAttempts",
"documentation":"<p>The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.</p> <p>For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeconds as 50 seconds, AWS Config throws an exception after the 5th failed attempt within 50 seconds.</p>"
},
"RetryAttemptSeconds":{
"shape":"AutoRemediationAttemptSeconds",
"documentation":"<p>Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds. </p> <p>For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception. </p>"
},
"Arn":{
"shape":"StringWithCharLimit1024",
"documentation":"<p>Amazon Resource Name (ARN) of remediation configuration.</p>"
},
"CreatedByService":{
"shape":"StringWithCharLimit1024",
"documentation":"<p>Name of the service that owns the service linked rule, if applicable.</p>"
}
},
"documentation":"<p>An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.</p>"
@ -3988,6 +4416,63 @@
"max":25,
"min":0
},
"RemediationException":{
"type":"structure",
"required":[
"ConfigRuleName",
"ResourceType",
"ResourceId"
],
"members":{
"ConfigRuleName":{
"shape":"ConfigRuleName",
"documentation":"<p>The name of the AWS Config rule.</p>"
},
"ResourceType":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The type of a resource.</p>"
},
"ResourceId":{
"shape":"StringWithCharLimit1024",
"documentation":"<p>The ID of the resource (for example., sg-xxxxxx).</p>"
},
"Message":{
"shape":"StringWithCharLimit1024",
"documentation":"<p>An explanation of an remediation exception.</p>"
},
"ExpirationTime":{
"shape":"Date",
"documentation":"<p>The time when the remediation exception will be deleted.</p>"
}
},
"documentation":"<p>An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type. </p>"
},
"RemediationExceptionResourceKey":{
"type":"structure",
"members":{
"ResourceType":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The type of a resource.</p>"
},
"ResourceId":{
"shape":"StringWithCharLimit1024",
"documentation":"<p>The ID of the resource (for example., sg-xxxxxx).</p>"
}
},
"documentation":"<p>The details that identify a resource within AWS Config, including the resource type and resource ID. </p>"
},
"RemediationExceptionResourceKeys":{
"type":"list",
"member":{"shape":"RemediationExceptionResourceKey"},
"max":100,
"min":1
},
"RemediationExceptions":{
"type":"list",
"member":{"shape":"RemediationException"},
"max":25,
"min":0
},
"RemediationExecutionState":{
"type":"string",
"enum":[
@ -4066,6 +4551,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>Remediation action is in progress. You can either cancel execution in AWS Systems Manager or wait and try again later. </p>",
"exception":true
},
"RemediationParameterValue":{
@ -4206,7 +4692,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The rule is currently being deleted or the rule is deleting your evaluation results. Try your request again later.</p>",
"documentation":"<p>You see this exception in the following cases: </p> <ul> <li> <p>For DeleteConfigRule API, AWS Config is deleting this rule. Try your request again later.</p> </li> <li> <p>For DeleteConfigRule API, the rule is deleting your evaluation results. Try your request again later.</p> </li> <li> <p>For DeleteConfigRule API, a remediation action is associated with the rule and AWS Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.</p> </li> <li> <p>For PutConfigOrganizationRule, organization config rule deletion is in progress. Try your request again later.</p> </li> <li> <p>For DeleteOrganizationConfigRule, organization config rule creation is in progress. Try your request again later.</p> </li> </ul>",
"exception":true
},
"ResourceKey":{
@ -4266,55 +4752,81 @@
"AWS::EC2::VPC",
"AWS::EC2::VPNConnection",
"AWS::EC2::VPNGateway",
"AWS::EC2::RegisteredHAInstance",
"AWS::EC2::NatGateway",
"AWS::EC2::EgressOnlyInternetGateway",
"AWS::EC2::VPCEndpoint",
"AWS::EC2::VPCEndpointService",
"AWS::EC2::FlowLog",
"AWS::EC2::VPCPeeringConnection",
"AWS::IAM::Group",
"AWS::IAM::Policy",
"AWS::IAM::Role",
"AWS::IAM::User",
"AWS::ElasticLoadBalancingV2::LoadBalancer",
"AWS::ACM::Certificate",
"AWS::RDS::DBInstance",
"AWS::RDS::DBParameterGroup",
"AWS::RDS::DBOptionGroup",
"AWS::RDS::DBSubnetGroup",
"AWS::RDS::DBSecurityGroup",
"AWS::RDS::DBSnapshot",
"AWS::RDS::DBCluster",
"AWS::RDS::DBClusterParameterGroup",
"AWS::RDS::DBClusterSnapshot",
"AWS::RDS::EventSubscription",
"AWS::ElasticLoadBalancingV2::LoadBalancer",
"AWS::S3::Bucket",
"AWS::SSM::ManagedInstanceInventory",
"AWS::S3::AccountPublicAccessBlock",
"AWS::Redshift::Cluster",
"AWS::Redshift::ClusterSnapshot",
"AWS::Redshift::ClusterParameterGroup",
"AWS::Redshift::ClusterSecurityGroup",
"AWS::Redshift::ClusterSubnetGroup",
"AWS::Redshift::EventSubscription",
"AWS::SSM::ManagedInstanceInventory",
"AWS::CloudWatch::Alarm",
"AWS::CloudFormation::Stack",
"AWS::DynamoDB::Table",
"AWS::ElasticLoadBalancing::LoadBalancer",
"AWS::AutoScaling::AutoScalingGroup",
"AWS::AutoScaling::LaunchConfiguration",
"AWS::AutoScaling::ScalingPolicy",
"AWS::AutoScaling::ScheduledAction",
"AWS::DynamoDB::Table",
"AWS::CodeBuild::Project",
"AWS::WAF::RateBasedRule",
"AWS::WAF::Rule",
"AWS::WAF::RuleGroup",
"AWS::WAF::WebACL",
"AWS::WAFRegional::RateBasedRule",
"AWS::WAFRegional::Rule",
"AWS::WAFRegional::RuleGroup",
"AWS::WAFRegional::WebACL",
"AWS::CloudFront::Distribution",
"AWS::CloudFront::StreamingDistribution",
"AWS::WAF::RuleGroup",
"AWS::WAFRegional::RuleGroup",
"AWS::Lambda::Alias",
"AWS::Lambda::Function",
"AWS::ElasticBeanstalk::Application",
"AWS::ElasticBeanstalk::ApplicationVersion",
"AWS::ElasticBeanstalk::Environment",
"AWS::ElasticLoadBalancing::LoadBalancer",
"AWS::MobileHub::Project",
"AWS::XRay::EncryptionConfig",
"AWS::SSM::AssociationCompliance",
"AWS::SSM::PatchCompliance",
"AWS::Shield::Protection",
"AWS::ShieldRegional::Protection",
"AWS::Config::ResourceCompliance",
"AWS::CodePipeline::Pipeline"
"AWS::LicenseManager::LicenseConfiguration",
"AWS::ApiGateway::DomainName",
"AWS::ApiGateway::Method",
"AWS::ApiGateway::Stage",
"AWS::ApiGateway::RestApi",
"AWS::ApiGatewayV2::DomainName",
"AWS::ApiGatewayV2::Stage",
"AWS::ApiGatewayV2::Api",
"AWS::CodePipeline::Pipeline",
"AWS::ServiceCatalog::CloudFormationProvisionedProduct",
"AWS::ServiceCatalog::CloudFormationProduct",
"AWS::ServiceCatalog::Portfolio"
]
},
"ResourceTypeList":{
@ -4335,6 +4847,7 @@
},
"ResourceValue":{
"type":"structure",
"required":["Value"],
"members":{
"Value":{
"shape":"ResourceValueType",
@ -4498,6 +5011,20 @@
"max":25,
"min":0
},
"SsmControls":{
"type":"structure",
"members":{
"ConcurrentExecutionRatePercentage":{
"shape":"Percentage",
"documentation":"<p>The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10. </p>"
},
"ErrorPercentage":{
"shape":"Percentage",
"documentation":"<p>The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received. </p>"
}
},
"documentation":"<p>AWS Systems Manager (SSM) specific remediation controls.</p>"
},
"StartConfigRulesEvaluationRequest":{
"type":"structure",
"members":{
@ -4533,7 +5060,7 @@
],
"members":{
"ConfigRuleName":{
"shape":"StringWithCharLimit64",
"shape":"ConfigRuleName",
"documentation":"<p>The list of names of AWS Config rules that you want to run remediation execution for.</p>"
},
"ResourceKeys":{
@ -4563,6 +5090,7 @@
},
"StaticValue":{
"type":"structure",
"required":["Values"],
"members":{
"Values":{
"shape":"StaticParameterValues",
@ -4574,9 +5102,16 @@
"StatusDetailFilters":{
"type":"structure",
"members":{
"AccountId":{"shape":"AccountId"},
"MemberAccountRuleStatus":{"shape":"MemberAccountRuleStatus"}
}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The 12-digit account ID of the member account within an organization.</p>"
},
"MemberAccountRuleStatus":{
"shape":"MemberAccountRuleStatus",
"documentation":"<p>Indicates deployment status for config rule in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the first time, config rule status is created in the member account. When master account calls <code>PutOrganizationConfigRule</code> action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes <code>OrganizationConfigRule</code> and disables service access for <code>config-multiaccountsetup.amazonaws.com</code>. </p> <p>AWS Config sets the state of the rule to:</p> <ul> <li> <p> <code>CREATE_SUCCESSFUL</code> when config rule has been created in the member account.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> when config rule is being created in the member account.</p> </li> <li> <p> <code>CREATE_FAILED</code> when config rule creation has failed in the member account.</p> </li> <li> <p> <code>DELETE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> when config rule is being deleted in the member account.</p> </li> <li> <p> <code>DELETE_SUCCESSFUL</code> when config rule has been deleted in the member account.</p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> when config rule has been updated in the member account.</p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> when config rule is being updated in the member account.</p> </li> <li> <p> <code>UPDATE_FAILED</code> when config rule deletion has failed in the member account.</p> </li> </ul>"
}
},
"documentation":"<p>Status filter object to filter results based on specific member account ID or status type for an organization config rule. </p>"
},
"StopConfigurationRecorderRequest":{
"type":"structure",

33
botocore/data/cur/2017-01-06/service-2.json
View file

@ -40,6 +40,20 @@
],
"documentation":"<p>Lists the AWS Cost and Usage reports available to this account.</p>"
},
"ModifyReportDefinition":{
"name":"ModifyReportDefinition",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyReportDefinitionRequest"},
"output":{"shape":"ModifyReportDefinitionResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Allows you to programatically update your report preferences.</p>"
},
"PutReportDefinition":{
"name":"PutReportDefinition",
"http":{
@ -71,7 +85,8 @@
"ap-southeast-2",
"ap-northeast-1",
"eu-north-1",
"ap-northeast-3"
"ap-northeast-3",
"ap-east-1"
]
},
"AdditionalArtifact":{
@ -166,6 +181,22 @@
"max":5,
"min":5
},
"ModifyReportDefinitionRequest":{
"type":"structure",
"required":[
"ReportName",
"ReportDefinition"
],
"members":{
"ReportName":{"shape":"ReportName"},
"ReportDefinition":{"shape":"ReportDefinition"}
}
},
"ModifyReportDefinitionResponse":{
"type":"structure",
"members":{
}
},
"PutReportDefinitionRequest":{
"type":"structure",
"required":["ReportDefinition"],

205
botocore/data/datasync/2018-11-09/service-2.json
View file

@ -82,7 +82,21 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.</p> <p>For more information, see Configuring Amazon S3 Location Settings in the <i>AWS DataSync User Guide.</i> </p>"
"documentation":"<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.</p> <p>For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the <i>AWS DataSync User Guide.</i> </p>"
},
"CreateLocationSmb":{
"name":"CreateLocationSmb",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateLocationSmbRequest"},
"output":{"shape":"CreateLocationSmbResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Creates an endpoint for a Server Message Block (SMB) file system.</p>"
},
"CreateTask":{
"name":"CreateTask",
@ -196,6 +210,20 @@
],
"documentation":"<p>Returns metadata, such as bucket name, about an Amazon S3 bucket location.</p>"
},
"DescribeLocationSmb":{
"name":"DescribeLocationSmb",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLocationSmbRequest"},
"output":{"shape":"DescribeLocationSmbResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Returns metadata, such as the path and user information about a SMB location.</p>"
},
"DescribeTask":{
"name":"DescribeTask",
"http":{
@ -460,7 +488,7 @@
},
"SubnetArns":{
"shape":"PLSubnetArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create Elastic Network Interfaces (ENIs) for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four ENIs for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four ENIs.</p>"
"documentation":"<p>The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.</p>"
},
"SecurityGroupArns":{
"shape":"PLSecurityGroupArnList",
@ -571,6 +599,10 @@
"shape":"S3BucketArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket.</p>"
},
"S3StorageClass":{
"shape":"S3StorageClass",
"documentation":"<p>The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For more information about S3 storage classes, see <a href=\"https://aws.amazon.com/s3/storage-classes/\">Amazon S3 Storage Classes</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see <a>using-storage-classes</a>.</p>"
},
"S3Config":{"shape":"S3Config"},
"Tags":{
"shape":"TagList",
@ -589,6 +621,61 @@
},
"documentation":"<p>CreateLocationS3Response</p>"
},
"CreateLocationSmbRequest":{
"type":"structure",
"required":[
"Subdirectory",
"ServerHostname",
"User",
"Password",
"AgentArns"
],
"members":{
"Subdirectory":{
"shape":"NonEmptySubdirectory",
"documentation":"<p>The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.</p> <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.</p>"
},
"ServerHostname":{
"shape":"ServerHostname",
"documentation":"<p>The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.</p> <note> <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p> </note>"
},
"User":{
"shape":"SmbUser",
"documentation":"<p>The user who can mount the share, has the permissions to access files and folders in the SMB share.</p>"
},
"Domain":{
"shape":"SmbDomain",
"documentation":"<p>The name of the Windows domain that the SMB server belongs to.</p>"
},
"Password":{
"shape":"SmbPassword",
"documentation":"<p>The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.</p>"
},
"AgentArns":{
"shape":"AgentArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location. </p>"
},
"MountOptions":{
"shape":"SmbMountOptions",
"documentation":"<p>The mount options used by DataSync to access the SMB server.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>"
}
},
"documentation":"<p>CreateLocationSmbRequest</p>"
},
"CreateLocationSmbResponse":{
"type":"structure",
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the source SMB file system location that is created.</p>"
}
},
"documentation":"<p>CreateLocationSmbResponse</p>"
},
"CreateTaskRequest":{
"type":"structure",
"required":[
@ -816,6 +903,10 @@
"shape":"LocationUri",
"documentation":"<p>The URL of the Amazon S3 location that was described.</p>"
},
"S3StorageClass":{
"shape":"S3StorageClass",
"documentation":"<p>The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see <a href=\"https://aws.amazon.com/s3/storage-classes/\">Amazon S3 Storage Classes</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see <a>using-storage-classes</a>.</p>"
},
"S3Config":{"shape":"S3Config"},
"CreationTime":{
"shape":"Time",
@ -824,6 +915,51 @@
},
"documentation":"<p>DescribeLocationS3Response</p>"
},
"DescribeLocationSmbRequest":{
"type":"structure",
"required":["LocationArn"],
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon resource Name (ARN) of the SMB location to describe.</p>"
}
},
"documentation":"<p>DescribeLocationSmbRequest</p>"
},
"DescribeLocationSmbResponse":{
"type":"structure",
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon resource Name (ARN) of the SMB location that was described.</p>"
},
"LocationUri":{
"shape":"LocationUri",
"documentation":"<p>The URL of the source SBM location that was described.</p>"
},
"AgentArns":{
"shape":"AgentArnList",
"documentation":"<p>The Amazon Resource Name (ARN) of the source SMB file system location that is created.</p>"
},
"User":{
"shape":"SmbUser",
"documentation":"<p>The user who can mount the share, has the permissions to access files and folders in the SMB share.</p>"
},
"Domain":{
"shape":"SmbDomain",
"documentation":"<p>The name of the Windows domain that the SMB server belongs to.</p>"
},
"MountOptions":{
"shape":"SmbMountOptions",
"documentation":"<p>The mount options that are available for DataSync to use to access an SMB location.</p>"
},
"CreationTime":{
"shape":"Time",
"documentation":"<p>The time that the SMB location was created.</p>"
}
},
"documentation":"<p>DescribeLocationSmbResponse</p>"
},
"DescribeTaskExecutionRequest":{
"type":"structure",
"required":["TaskExecutionArn"],
@ -1257,7 +1393,8 @@
},
"LocationUri":{
"type":"string",
"pattern":"(efs|nfs|s3)://[a-zA-Z0-9.\\-]+"
"max":4355,
"pattern":"^(efs|nfs|s3|smb)://[a-zA-Z0-9.\\-]+$"
},
"LogGroupArn":{
"type":"string",
@ -1291,7 +1428,7 @@
"members":{
"Version":{
"shape":"NfsVersion",
"documentation":"<p>The specific NFS version that you want DataSync to use to mount your NFS share. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the NFS server.</p>"
"documentation":"<p>The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the NFS server.</p> <p>You can specify the following NFS versions:</p> <ul> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc1813\">NFSv3</a> </b> - stateless protocol version that allows for asynchronous writes on the server.</p> </li> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc3530\">NFSv4.0</a> </b> - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.</p> </li> <li> <p> <b> <a href=\"https://tools.ietf.org/html/rfc5661\">NFSv4.1</a> </b> - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the mount options that are available for DataSync to access an NFS location.</p>"
@ -1326,7 +1463,11 @@
"members":{
"VerifyMode":{
"shape":"VerifyMode",
"documentation":"<p>A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. </p> <p>Default value: POINT_IN_TIME_CONSISTENT.</p> <p>POINT_IN_TIME_CONSISTENT: Perform verification (recommended). </p> <p>NONE: Skip verification.</p>"
"documentation":"<p>A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. </p> <p>Default value: POINT_IN_TIME_CONSISTENT.</p> <p>POINT_IN_TIME_CONSISTENT: Perform verification (recommended). </p> <p>ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.</p> <p>NONE: Skip verification.</p>"
},
"OverwriteMode":{
"shape":"OverwriteMode",
"documentation":"<p>A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to <code>NEVER</code> a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes. </p> <p>Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see <a>using-storage-classes</a> in the <i>AWS DataSync User Guide</i>.</p>"
},
"Atime":{
"shape":"Atime",
@ -1346,7 +1487,7 @@
},
"PreserveDeletedFiles":{
"shape":"PreserveDeletedFiles",
"documentation":"<p>A value that specifies whether files in the destination that don't exist in the source file system should be preserved. </p> <p>Default value: PRESERVE.</p> <p>PRESERVE: Ignore such destination files (recommended). </p> <p>REMOVE: Delete destination files that aren’t present in the source.</p>"
"documentation":"<p>A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see <a>using-storage-classes</a> in the <i>AWS DataSync User Guide</i>.</p> <p>Default value: PRESERVE.</p> <p>PRESERVE: Ignore such destination files (recommended). </p> <p>REMOVE: Delete destination files that aren’t present in the source.</p>"
},
"PreserveDevices":{
"shape":"PreserveDevices",
@ -1363,6 +1504,13 @@
},
"documentation":"<p>Represents the options that are available to control the behavior of a <a>StartTaskExecution</a> operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.</p> <p>A task has a set of default options associated with it. If you don't specify an option in <a>StartTaskExecution</a>, the default value is used. You can override the defaults options on each task execution by specifying an overriding <code>Options</code> value to <a>StartTaskExecution</a>.</p>"
},
"OverwriteMode":{
"type":"string",
"enum":[
"ALWAYS",
"NEVER"
]
},
"PLSecurityGroupArnList":{
"type":"list",
"member":{"shape":"Ec2SecurityGroupArn"},
@ -1443,11 +1591,55 @@
},
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.</p> <p>For detailed information about using such a role, see Creating a Location for Amazon S3 in the <i>AWS DataSync User Guide</i>.</p>"
},
"S3StorageClass":{
"type":"string",
"enum":[
"STANDARD",
"STANDARD_IA",
"ONEZONE_IA",
"INTELLIGENT_TIERING",
"GLACIER",
"DEEP_ARCHIVE"
]
},
"ServerHostname":{
"type":"string",
"max":255,
"pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$"
},
"SmbDomain":{
"type":"string",
"max":253,
"pattern":"^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$"
},
"SmbMountOptions":{
"type":"structure",
"members":{
"Version":{
"shape":"SmbVersion",
"documentation":"<p>The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to <code>AUTOMATIC</code>. That is, DataSync automatically selects a version based on negotiation with the SMB server.</p>"
}
},
"documentation":"<p>Represents the mount options that are available for DataSync to access an SMB location.</p>"
},
"SmbPassword":{
"type":"string",
"max":104,
"pattern":"^.{0,104}$"
},
"SmbUser":{
"type":"string",
"max":104,
"pattern":"^[^\\\\x5B\\\\x5D\\\\/:;|=,+*?]{1,104}$"
},
"SmbVersion":{
"type":"string",
"enum":[
"AUTOMATIC",
"SMB2",
"SMB3"
]
},
"SourceNetworkInterfaceArns":{
"type":"list",
"member":{"shape":"NetworkInterfaceArn"}
@ -1744,6 +1936,7 @@
"type":"string",
"enum":[
"POINT_IN_TIME_CONSISTENT",
"ONLY_FILES_TRANSFERRED",
"NONE"
]
},

69
botocore/data/dms/2016-01-01/service-2.json
View file

@ -150,6 +150,21 @@
],
"documentation":"<p>Deletes the specified certificate. </p>"
},
"DeleteConnection":{
"name":"DeleteConnection",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConnectionMessage"},
"output":{"shape":"DeleteConnectionResponse"},
"errors":[
{"shape":"AccessDeniedFault"},
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"<p>Deletes the connection between a replication instance and an endpoint.</p>"
},
"DeleteEndpoint":{
"name":"DeleteEndpoint",
"http":{
@ -971,7 +986,7 @@
},
"DmsTransferSettings":{
"shape":"DmsTransferSettings",
"documentation":"<p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Possible attributes include the following:</p> <ul> <li> <p> <code>serviceAccessRoleArn</code> - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p> <code>bucketName</code> - The name of the S3 bucket to use.</p> </li> <li> <p> <code>compressionType</code> - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to <code>NONE</code> (the default). To keep the files uncompressed, don't use this value.</p> </li> </ul> <p>Shorthand syntax for these attributes is as follows: <code>ServiceAccessRoleArn=string,BucketName=string,CompressionType=string</code> </p> <p>JSON syntax for these attributes is as follows: <code>{ \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </code> </p>"
"documentation":"<p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Possible settings include the following:</p> <ul> <li> <p> <code>ServiceAccessRoleArn</code> - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p> <code>BucketName</code> - The name of the S3 bucket to use.</p> </li> <li> <p> <code>CompressionType</code> - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to <code>NONE</code> (the default). To keep the files uncompressed, don't use this value.</p> </li> </ul> <p>Shorthand syntax for these settings is as follows: <code>ServiceAccessRoleArn=string,BucketName=string,CompressionType=string</code> </p> <p>JSON syntax for these settings is as follows: <code>{ \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </code> </p>"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
@ -1254,6 +1269,34 @@
}
}
},
"DeleteConnectionMessage":{
"type":"structure",
"required":[
"EndpointArn",
"ReplicationInstanceArn"
],
"members":{
"EndpointArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>"
},
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the replication instance.</p>"
}
},
"documentation":"<p/>"
},
"DeleteConnectionResponse":{
"type":"structure",
"members":{
"Connection":{
"shape":"Connection",
"documentation":"<p>The connection that is being deleted.</p>"
}
},
"documentation":"<p/>"
},
"DeleteEndpointMessage":{
"type":"structure",
"required":["EndpointArn"],
@ -1370,7 +1413,7 @@
},
"UniqueAccountIdentifier":{
"shape":"String",
"documentation":"<p>A unique AWS DMS identifier for an account in a particular AWS Region. The value of this identifier has the following format: <code>c99999999999</code>. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given AWS Region. The format of this S3 bucket name is the following: <code>dms-<i>AccountNumber</i>-<i>UniqueAccountIdentifier</i>.</code> Here is an example name for this default S3 bucket: <code>dms-111122223333-c44445555666</code>.</p> <note> <p>AWS DMS supports <code>UniqueAccountIdentifier</code> in versions 3.1.4 and later.</p> </note>"
"documentation":"<p>A unique AWS DMS identifier for an account in a particular AWS Region. The value of this identifier has the following format: <code>c99999999999</code>. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given AWS Region. The format of this S3 bucket name is the following: <code>dms-<i>AccountNumber</i>-<i>UniqueAccountIdentifier</i>.</code> Here is an example name for this default S3 bucket: <code>dms-111122223333-c44445555666</code>.</p> <note> <p>AWS DMS supports the <code>UniqueAccountIdentifier</code> parameter in versions 3.1.4 and later.</p> </note>"
}
},
"documentation":"<p/>"
@ -2103,7 +2146,7 @@
},
"DmsTransferSettings":{
"shape":"DmsTransferSettings",
"documentation":"<p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Possible attributes include the following:</p> <ul> <li> <p> <code>serviceAccessRoleArn</code> - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p> <code>bucketName</code> - The name of the S3 bucket to use.</p> </li> <li> <p> <code>compressionType</code> - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to <code>NONE</code> (the default). To keep the files uncompressed, don't use this value.</p> </li> </ul> <p>Shorthand syntax for these attributes is as follows: <code>ServiceAccessRoleArn=string,BucketName=string,CompressionType=string</code> </p> <p>JSON syntax for these attributes is as follows: <code>{ \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </code> </p>"
"documentation":"<p>The settings in JSON format for the DMS transfer type of source endpoint. </p> <p>Possible settings include the following:</p> <ul> <li> <p> <code>ServiceAccessRoleArn</code> - The IAM role that has permission to access the Amazon S3 bucket.</p> </li> <li> <p> <code>BucketName</code> - The name of the S3 bucket to use.</p> </li> <li> <p> <code>CompressionType</code> - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to <code>NONE</code> (the default). To keep the files uncompressed, don't use this value.</p> </li> </ul> <p>Shorthand syntax for these settings is as follows: <code>ServiceAccessRoleArn=string,BucketName=string,CompressionType=string</code> </p> <p>JSON syntax for these settings is as follows: <code>{ \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" } </code> </p>"
},
"MongoDbSettings":{
"shape":"MongoDbSettings",
@ -2740,7 +2783,7 @@
},
"AuthMechanism":{
"shape":"AuthMechanismValue",
"documentation":"<p> The authentication mechanism you use to access the MongoDB source endpoint.</p> <p>Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 </p> <p>DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.</p>"
"documentation":"<p> The authentication mechanism you use to access the MongoDB source endpoint.</p> <p>Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 </p> <p>DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This setting is not used when authType=No.</p>"
},
"NestingLevel":{
"shape":"NestingLevelValue",
@ -2748,15 +2791,15 @@
},
"ExtractDocId":{
"shape":"String",
"documentation":"<p> Specifies the document ID. Use this attribute when <code>NestingLevel</code> is set to NONE. </p> <p>Default value is false. </p>"
"documentation":"<p> Specifies the document ID. Use this setting when <code>NestingLevel</code> is set to NONE. </p> <p>Default value is false. </p>"
},
"DocsToInvestigate":{
"shape":"String",
"documentation":"<p> Indicates the number of documents to preview to determine the document organization. Use this attribute when <code>NestingLevel</code> is set to ONE. </p> <p>Must be a positive value greater than 0. Default value is 1000.</p>"
"documentation":"<p> Indicates the number of documents to preview to determine the document organization. Use this setting when <code>NestingLevel</code> is set to ONE. </p> <p>Must be a positive value greater than 0. Default value is 1000.</p>"
},
"AuthSource":{
"shape":"String",
"documentation":"<p> The MongoDB database name. This attribute is not used when <code>authType=NO</code>. </p> <p>The default is admin.</p>"
"documentation":"<p> The MongoDB database name. This setting is not used when <code>authType=NO</code>. </p> <p>The default is admin.</p>"
},
"KmsKeyId":{
"shape":"String",
@ -2809,7 +2852,7 @@
},
"ReleaseStatus":{
"shape":"ReleaseStatusValues",
"documentation":"<p>The value returned when the specified <code>EngineVersion</code> of the replication instance is in Beta or test mode. This indicates some features might not work as expected.</p> <note> <p>AWS DMS supports <code>ReleaseStatus</code> in versions 3.1.4 and later.</p> </note>"
"documentation":"<p>The value returned when the specified <code>EngineVersion</code> of the replication instance is in Beta or test mode. This indicates some features might not work as expected.</p> <note> <p>AWS DMS supports the <code>ReleaseStatus</code> parameter in versions 3.1.4 and later.</p> </note>"
}
},
"documentation":"<p/>"
@ -3587,15 +3630,19 @@
},
"IncludeOpForFullLoad":{
"shape":"BooleanOptional",
"documentation":"<p>A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.</p> <note> <p>AWS DMS supports <code>IncludeOpForFullLoad</code> in versions 3.1.4 and later.</p> </note> <p>For full load, records can only be inserted. By default (the <code>false</code> setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If <code>IncludeOpForFullLoad</code> is set to <code>true</code> or <code>y</code>, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.</p> <note> <p>This setting works together with <code>CdcInsertsOnly</code> for output to .csv files only. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> </note>"
"documentation":"<p>A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.</p> <note> <p>AWS DMS supports the <code>IncludeOpForFullLoad</code> parameter in versions 3.1.4 and later.</p> </note> <p>For full load, records can only be inserted. By default (the <code>false</code> setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If <code>IncludeOpForFullLoad</code> is set to <code>true</code> or <code>y</code>, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.</p> <note> <p>This setting works together with the <code>CdcInsertsOnly</code> parameter for output to .csv files only. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> </note>"
},
"CdcInsertsOnly":{
"shape":"BooleanOptional",
"documentation":"<p>A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the <code>false</code> setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.</p> <p>If <code>cdcInsertsOnly</code> is set to <code>true</code> or <code>y</code>, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of <code>IncludeOpForFullLoad</code>. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If <code>IncludeOpForFullLoad</code> is set to <code>false</code>, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> <note> <p>AWS DMS supports this interaction between <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> in versions 3.1.4 and later. </p> </note>"
"documentation":"<p>A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the <code>false</code> setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.</p> <p>If <code>CdcInsertsOnly</code> is set to <code>true</code> or <code>y</code>, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of <code>IncludeOpForFullLoad</code>. If <code>IncludeOpForFullLoad</code> is set to <code>true</code>, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If <code>IncludeOpForFullLoad</code> is set to <code>false</code>, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring.InsertOps\">Indicating Source DB Operations in Migrated S3 Data</a> in the <i>AWS Database Migration Service User Guide.</i>.</p> <note> <p>AWS DMS supports this interaction between the <code>CdcInsertsOnly</code> and <code>IncludeOpForFullLoad</code> parameters in versions 3.1.4 and later. </p> </note>"
},
"TimestampColumnName":{
"shape":"String",
"documentation":"<p>A value that includes a timestamp column in the Amazon S3 target endpoint data. AWS DMS includes an additional column in the migrated data when you set <code>timestampColumnName</code> to a non-blank value. </p> <note> <p>AWS DMS supports <code>TimestampColumnName</code> in versions 3.1.4 and later.</p> </note> <p>For a full load, each row of the timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. For a CDC load, each row of the timestamp column contains the timestamp for the commit of that row in the source database. The format for the timestamp column value is <code>yyyy-MM-dd HH:mm:ss.SSSSSS</code>. For CDC, the microsecond precision depends on the commit timestamp supported by DMS for the source database. When the <code>AddColumnName</code> setting is set to <code>true</code>, DMS also includes the name for the timestamp column that you set as the nonblank value of <code>timestampColumnName</code>.</p>"
"documentation":"<p>A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.</p> <note> <p>AWS DMS supports the <code>TimestampColumnName</code> parameter in versions 3.1.4 and later.</p> </note> <p>DMS includes an additional <code>STRING</code> column in the .csv or .parquet object files of your migrated data when you set <code>TimestampColumnName</code> to a nonblank value.</p> <p>For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS. </p> <p>For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.</p> <p>The string format for this timestamp column value is <code>yyyy-MM-dd HH:mm:ss.SSSSSS</code>. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.</p> <p>When the <code>AddColumnName</code> parameter is set to <code>true</code>, DMS also includes a name for the timestamp column that you set with <code>TimestampColumnName</code>.</p>"
},
"ParquetTimestampInMillisecond":{
"shape":"BooleanOptional",
"documentation":"<p>A value that specifies the precision of any <code>TIMESTAMP</code> column values that are written to an Amazon S3 object file in .parquet format.</p> <note> <p>AWS DMS supports the <code>ParquetTimestampInMillisecond</code> parameter in versions 3.1.4 and later.</p> </note> <p>When <code>ParquetTimestampInMillisecond</code> is set to <code>true</code> or <code>y</code>, AWS DMS writes all <code>TIMESTAMP</code> columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.</p> <p>Currently, Amazon Athena and AWS Glue can handle only millisecond precision for <code>TIMESTAMP</code> values. Set this parameter to <code>true</code> for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.</p> <note> <p>AWS DMS writes any <code>TIMESTAMP</code> column values written to an S3 file in .csv format with microsecond precision.</p> <p>Setting <code>ParquetTimestampInMillisecond</code> has no effect on the string format of the timestamp column value that is inserted by setting the <code>TimestampColumnName</code> parameter.</p> </note>"
}
},
"documentation":"<p>Settings for exporting data to Amazon S3. </p>"

110
botocore/data/docdb/2014-10-31/service-2.json
View file

@ -285,6 +285,22 @@
],
"documentation":"<p>Deletes a DB subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>"
},
"DescribeCertificates":{
"name":"DescribeCertificates",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCertificatesMessage"},
"output":{
"shape":"CertificateMessage",
"resultWrapper":"DescribeCertificatesResult"
},
"errors":[
{"shape":"CertificateNotFoundFault"}
],
"documentation":"<p>Returns a list of certificate authority (CA) certificates provided by Amazon RDS for this AWS account.</p>"
},
"DescribeDBClusterParameterGroups":{
"name":"DescribeDBClusterParameterGroups",
"http":{
@ -870,6 +886,57 @@
},
"Boolean":{"type":"boolean"},
"BooleanOptional":{"type":"boolean"},
"Certificate":{
"type":"structure",
"members":{
"CertificateIdentifier":{
"shape":"String",
"documentation":"<p>The unique key that identifies a certificate.</p> <p>Example: <code>rds-ca-2019</code> </p>"
},
"CertificateType":{
"shape":"String",
"documentation":"<p>The type of the certificate.</p> <p>Example: <code>CA</code> </p>"
},
"Thumbprint":{
"shape":"String",
"documentation":"<p>The thumbprint of the certificate.</p>"
},
"ValidFrom":{
"shape":"TStamp",
"documentation":"<p>The starting date-time from which the certificate is valid.</p> <p>Example: <code>2019-07-31T17:57:09Z</code> </p>"
},
"ValidTill":{
"shape":"TStamp",
"documentation":"<p>The date-time after which the certificate is no longer valid.</p> <p>Example: <code>2024-07-31T17:57:09Z</code> </p>"
},
"CertificateArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the certificate.</p> <p>Example: <code>arn:aws:rds:us-east-1::cert:rds-ca-2019</code> </p>"
}
},
"documentation":"<p>A certificate authority (CA) certificate for an AWS account.</p>",
"wrapper":true
},
"CertificateList":{
"type":"list",
"member":{
"shape":"Certificate",
"locationName":"Certificate"
}
},
"CertificateMessage":{
"type":"structure",
"members":{
"Certificates":{
"shape":"CertificateList",
"documentation":"<p>A list of certificates for this AWS account.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided if the number of records retrieved is greater than <code>MaxRecords</code>. If this parameter is specified, the marker specifies the next record in the list. Including the value of <code>Marker</code> in the next call to <code>DescribeCertificates</code> results in the next page of certificates.</p>"
}
}
},
"CertificateNotFoundFault":{
"type":"structure",
"members":{
@ -1016,11 +1083,11 @@
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>The name of the master user for the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 16 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot be a reserved word for the chosen database engine.</p> </li> </ul>"
"documentation":"<p>The name of the master user for the DB cluster.</p> <p>Constraints:</p> <ul> <li> <p>Must be from 1 to 63 letters or numbers.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot be a reserved word for the chosen database engine.</p> </li> </ul>"
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).</p> <p>Constraints: Must contain from 8 to 41 characters.</p>"
"documentation":"<p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).</p> <p>Constraints: Must contain from 8 to 100 characters.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -1155,7 +1222,7 @@
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be assigned to the DB instance.</p>"
"documentation":"<p>The tags to be assigned to the DB instance. You can assign up to 10 tags to an instance.</p>"
},
"DBClusterIdentifier":{
"shape":"String",
@ -1802,7 +1869,7 @@
},
"PubliclyAccessible":{
"shape":"Boolean",
"documentation":"<p>Specifies the availability options for the DB instance. A value of <code>true</code> specifies an internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of <code>false</code> specifies an internal instance with a DNS name that resolves to a private IP address.</p>"
"documentation":"<p>Not supported. Amazon DocumentDB does not currently support public endpoints. The value of <code>PubliclyAccessible</code> is always <code>false</code>.</p>"
},
"StatusInfos":{
"shape":"DBInstanceStatusInfoList",
@ -1814,7 +1881,7 @@
},
"StorageEncrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the DB instance is encrypted.</p>"
"documentation":"<p>Specifies whether or not the DB instance is encrypted.</p>"
},
"KmsKeyId":{
"shape":"String",
@ -1824,6 +1891,10 @@
"shape":"String",
"documentation":"<p>The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.</p>"
},
"CACertificateIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the CA certificate for this DB instance.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p>"
@ -2011,7 +2082,7 @@
},
"DBSubnetGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Identifier (ARN) for the DB subnet group.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the DB subnet group.</p>"
}
},
"documentation":"<p>Detailed information about a DB subnet group. </p>",
@ -2191,6 +2262,27 @@
},
"documentation":"<p>Represents the input to <a>DeleteDBSubnetGroup</a>.</p>"
},
"DescribeCertificatesMessage":{
"type":"structure",
"members":{
"CertificateIdentifier":{
"shape":"String",
"documentation":"<p>The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to <code>MaxRecords</code> certificates is returned. This parameter is not case sensitive.</p> <p>Constraints</p> <ul> <li> <p>Must match an existing <code>CertificateIdentifier</code>.</p> </li> </ul>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints:</p> <ul> <li> <p>Minimum: 20</p> </li> <li> <p>Maximum: 100</p> </li> </ul>"
},
"Marker":{
"shape":"String",
"documentation":"<p>An optional pagination token provided by a previous <code>DescribeCertificates</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
"DescribeDBClusterParameterGroupsMessage":{
"type":"structure",
"members":{
@ -2979,7 +3071,7 @@
},
"MasterUserPassword":{
"shape":"String",
"documentation":"<p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).</p> <p>Constraints: Must contain from 8 to 41 characters.</p>"
"documentation":"<p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).</p> <p>Constraints: Must contain from 8 to 100 characters.</p>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -3088,6 +3180,10 @@
"shape":"String",
"documentation":"<p> The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you set <code>Apply Immediately</code> to <code>true</code>. It occurs during the next maintenance window if you set <code>Apply Immediately</code> to <code>false</code>. This value is stored as a lowercase string. </p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>mydbinstance</code> </p>"
},
"CACertificateIdentifier":{
"shape":"String",
"documentation":"<p>Indicates the certificate that needs to be associated with the instance.</p>"
},
"PromotionTier":{
"shape":"IntegerOptional",
"documentation":"<p>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.</p> <p>Default: 1</p> <p>Valid values: 0-15</p>"

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

@ -434,7 +434,7 @@
},
"input":{"shape":"CreateCustomerGatewayRequest"},
"output":{"shape":"CreateCustomerGatewayResult"},
"documentation":"<p>Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).</p> <p>For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).</p> <note> <p>Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> Region, and 9059, which is reserved in the <code>eu-west-1</code> Region.</p> </note> <p>For more information, see <a href=\"https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html\">AWS Site-to-Site VPN</a> in the <i>AWS Site-to-Site VPN User Guide</i>.</p> <important> <p>You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.</p> </important>"
"documentation":"<p>Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).</p> <p>For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).</p> <note> <p>Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the <code>us-east-1</code> Region, and 9059, which is reserved in the <code>eu-west-1</code> Region.</p> </note> <p>For more information, see <a href=\"https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html\">AWS Site-to-Site VPN</a> in the <i>AWS Site-to-Site VPN User Guide</i>.</p> <important> <p>You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.</p> </important>"
},
"CreateDefaultSubnet":{
"name":"CreateDefaultSubnet",
@ -861,7 +861,7 @@
},
"input":{"shape":"CreateVpnConnectionRequest"},
"output":{"shape":"CreateVpnConnectionResult"},
"documentation":"<p>Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The supported connection types is <code>ipsec.1</code>.</p> <p>The response includes information that you need to give to your network administrator to configure your customer gateway.</p> <important> <p>We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.</p> </important> <p>If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.</p> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html\">AWS Site-to-Site VPN</a> in the <i>AWS Site-to-Site VPN User Guide</i>.</p>"
"documentation":"<p>Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The supported connection type is <code>ipsec.1</code>.</p> <p>The response includes information that you need to give to your network administrator to configure your customer gateway.</p> <important> <p>We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.</p> </important> <p>If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.</p> <p>This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html\">AWS Site-to-Site VPN</a> in the <i>AWS Site-to-Site VPN User Guide</i>.</p>"
},
"CreateVpnConnectionRoute":{
"name":"CreateVpnConnectionRoute",
@ -1481,6 +1481,16 @@
"output":{"shape":"DescribeElasticGpusResult"},
"documentation":"<p>Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html\">Amazon Elastic Graphics</a>.</p>"
},
"DescribeExportImageTasks":{
"name":"DescribeExportImageTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeExportImageTasksRequest"},
"output":{"shape":"DescribeExportImageTasksResult"},
"documentation":"<p>Describes the specified export image tasks or all your export image tasks.</p>"
},
"DescribeExportTasks":{
"name":"DescribeExportTasks",
"http":{
@ -1489,7 +1499,7 @@
},
"input":{"shape":"DescribeExportTasksRequest"},
"output":{"shape":"DescribeExportTasksResult"},
"documentation":"<p>Describes the specified export tasks or all your export tasks.</p>"
"documentation":"<p>Describes the specified export instance tasks or all your export instance tasks.</p>"
},
"DescribeFleetHistory":{
"name":"DescribeFleetHistory",
@ -2523,6 +2533,16 @@
"output":{"shape":"ExportClientVpnClientConfigurationResult"},
"documentation":"<p>Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.</p>"
},
"ExportImage":{
"name":"ExportImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExportImageRequest"},
"output":{"shape":"ExportImageResult"},
"documentation":"<p>Exports an Amazon Machine Image (AMI) to a VM file. For more information, see <a href=\"https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html\">Exporting a VM Directory from an Amazon Machine Image (AMI)</a> in the <i>VM Import/Export User Guide</i>.</p>"
},
"ExportTransitGatewayRoutes":{
"name":"ExportTransitGatewayRoutes",
"http":{
@ -2751,7 +2771,7 @@
},
"input":{"shape":"ModifyFleetRequest"},
"output":{"shape":"ModifyFleetResult"},
"documentation":"<p>Modifies the specified EC2 Fleet.</p> <p>You can only modify an EC2 Fleet request of type <code>maintain</code>.</p> <p>While the EC2 Fleet is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is <code>lowestPrice</code>, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p> <p>To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.</p>"
"documentation":"<p>Modifies the specified EC2 Fleet.</p> <p>You can only modify an EC2 Fleet request of type <code>maintain</code>.</p> <p>While the EC2 Fleet is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is <code>lowestPrice</code>, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p> <p>To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.</p>"
},
"ModifyFpgaImageAttribute":{
"name":"ModifyFpgaImageAttribute",
@ -2895,7 +2915,7 @@
},
"input":{"shape":"ModifySpotFleetRequestRequest"},
"output":{"shape":"ModifySpotFleetRequestResponse"},
"documentation":"<p>Modifies the specified Spot Fleet request.</p> <p>You can only modify a Spot Fleet request of type <code>maintain</code>.</p> <p>While the Spot Fleet request is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p> <p>To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.</p>"
"documentation":"<p>Modifies the specified Spot Fleet request.</p> <p>You can only modify a Spot Fleet request of type <code>maintain</code>.</p> <p>While the Spot Fleet request is being modified, it is in the <code>modifying</code> state.</p> <p>To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is <code>diversified</code>, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p> <p>To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is <code>lowestPrice</code>, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is <code>capacityOptimized</code>, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is <code>diversified</code>, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.</p> <p>If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.</p>"
},
"ModifySubnetAttribute":{
"name":"ModifySubnetAttribute",
@ -3042,7 +3062,27 @@
},
"input":{"shape":"ModifyVpnConnectionRequest"},
"output":{"shape":"ModifyVpnConnectionResult"},
"documentation":"<p>Modifies the target gateway of a AWS Site-to-Site VPN connection. The following migration options are available:</p> <ul> <li> <p>An existing virtual private gateway to a new virtual private gateway</p> </li> <li> <p>An existing virtual private gateway to a transit gateway</p> </li> <li> <p>An existing transit gateway to a new transit gateway</p> </li> <li> <p>An existing transit gateway to a virtual private gateway</p> </li> </ul> <p>Before you perform the migration to the new gateway, you must configure the new gateway. Use <a>CreateVpnGateway</a> to create a virtual private gateway, or <a>CreateTransitGateway</a> to create a transit gateway.</p> <p>This step is required when you migrate from a virtual private gateway with static routes to a transit gateway. </p> <p>You must delete the static routes before you migrate to the new gateway.</p> <p>Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.</p> <p>After you migrate to the new gateway, you might need to modify your VPC route table. Use <a>CreateRoute</a> and <a>DeleteRoute</a> to make the changes described in <a href=\"https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing\">VPN Gateway Target Modification Required VPC Route Table Updates</a> in the <i>AWS Site-to-Site VPN User Guide</i>.</p> <p> When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use <a>CreateTransitGatewayRoute</a> to add the routes.</p> <p> If you deleted VPN static routes, you must add the static routes to the transit gateway route table.</p> <p>After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your s2slong; connection will be temporarily unavailable for approximately 10 minutes while we provision the new endpoints </p>"
"documentation":"<p>Modifies the target gateway of an AWS Site-to-Site VPN connection. The following migration options are available:</p> <ul> <li> <p>An existing virtual private gateway to a new virtual private gateway</p> </li> <li> <p>An existing virtual private gateway to a transit gateway</p> </li> <li> <p>An existing transit gateway to a new transit gateway</p> </li> <li> <p>An existing transit gateway to a virtual private gateway</p> </li> </ul> <p>Before you perform the migration to the new gateway, you must configure the new gateway. Use <a>CreateVpnGateway</a> to create a virtual private gateway, or <a>CreateTransitGateway</a> to create a transit gateway.</p> <p>This step is required when you migrate from a virtual private gateway with static routes to a transit gateway. </p> <p>You must delete the static routes before you migrate to the new gateway.</p> <p>Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.</p> <p>After you migrate to the new gateway, you might need to modify your VPC route table. Use <a>CreateRoute</a> and <a>DeleteRoute</a> to make the changes described in <a href=\"https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing\">VPN Gateway Target Modification Required VPC Route Table Updates</a> in the <i>AWS Site-to-Site VPN User Guide</i>.</p> <p> When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use <a>CreateTransitGatewayRoute</a> to add the routes.</p> <p> If you deleted VPN static routes, you must add the static routes to the transit gateway route table.</p> <p>After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your s2slong; connection will be temporarily unavailable for approximately 10 minutes while we provision the new endpoints </p>"
},
"ModifyVpnTunnelCertificate":{
"name":"ModifyVpnTunnelCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyVpnTunnelCertificateRequest"},
"output":{"shape":"ModifyVpnTunnelCertificateResult"},
"documentation":"<p>Modifies the VPN tunnel endpoint certificate.</p>"
},
"ModifyVpnTunnelOptions":{
"name":"ModifyVpnTunnelOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyVpnTunnelOptionsRequest"},
"output":{"shape":"ModifyVpnTunnelOptionsResult"},
"documentation":"<p>Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see <a href=\"https://docs.aws.amazon.com/vpn/latest/s2svpn/VPNTunnels.html\">Site-to-Site VPN Tunnel Options for Your Site-to-Site VPN Connection</a> in the <i>AWS Site-to-Site VPN User Guide</i>.</p>"
},
"MonitorInstances":{
"name":"MonitorInstances",
@ -3390,7 +3430,7 @@
"requestUri":"/"
},
"input":{"shape":"SendDiagnosticInterruptRequest"},
"documentation":"<p>Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a <i>kernel panic</i> (on Linux instances), or a <i>blue screen</i>/<i>stop error</i> (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a <i>non-maskable interrupt</i> (NMI).</p> <p>In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.</p> <p>Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.</p> <p>For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#diagnostic-interrupt\">Send a Diagnostic Interrupt</a> (Linux instances) or <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/unreachable-instance.html#diagnostic-interrupt\">Send a Diagnostic Interrupt</a> (Windows instances).</p>"
"documentation":"<p>Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a <i>kernel panic</i> (on Linux instances), or a <i>blue screen</i>/<i>stop error</i> (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a <i>non-maskable interrupt</i> (NMI).</p> <p>In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.</p> <p>Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.</p> <p>For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/diagnostic-interrupt.html\">Send a Diagnostic Interrupt</a> (Linux instances) or <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/diagnostic-interrupt.html\">Send a Diagnostic Interrupt</a> (Windows instances).</p>"
},
"StartInstances":{
"name":"StartInstances",
@ -6620,7 +6660,7 @@
},
"ThreadsPerCore":{
"shape":"Integer",
"documentation":"<p>The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of <code>1</code>. Otherwise, specify the default value of <code>2</code>.</p>"
"documentation":"<p>The number of threads per CPU core. To disable multithreading for the instance, specify a value of <code>1</code>. Otherwise, specify the default value of <code>2</code>.</p>"
}
},
"documentation":"<p>The CPU options for the instance. Both the core count and threads per core must be specified in the request.</p>"
@ -6828,7 +6868,6 @@
"type":"structure",
"required":[
"BgpAsn",
"PublicIp",
"Type"
],
"members":{
@ -6841,6 +6880,10 @@
"documentation":"<p>The Internet-routable IP address for the customer gateway's outside interface. The address must be static.</p>",
"locationName":"IpAddress"
},
"CertificateArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the customer gateway certificate.</p>"
},
"Type":{
"shape":"GatewayType",
"documentation":"<p>The type of VPN connection that this customer gateway supports (<code>ipsec.1</code>).</p>"
@ -7163,6 +7206,10 @@
"LogDestination":{
"shape":"String",
"documentation":"<p>Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for <code>LogDestinationType</code>.</p> <p>If LogDestinationType is not specified or <code>cloud-watch-logs</code>, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.</p> <p>If LogDestinationType is <code>s3</code>, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: <code>bucket_ARN/subfolder_name/</code>. For example, to specify a subfolder named <code>my-logs</code> in a bucket named <code>my-bucket</code>, use the following ARN: <code>arn:aws:s3:::my-bucket/my-logs/</code>. You cannot use <code>AWSLogs</code> as a subfolder name. This is a reserved term.</p>"
},
"LogFormat":{
"shape":"String",
"documentation":"<p>The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records\">Flow Log Records</a>. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.</p> <p>Specify the fields using the <code>${field-id}</code> format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.</p> <p>Only applicable to flow logs that are published to an Amazon S3 bucket.</p>"
}
}
},
@ -8876,6 +8923,11 @@
"documentation":"<p>The Internet-routable IP address of the customer gateway's outside interface.</p>",
"locationName":"ipAddress"
},
"CertificateArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the customer gateway certificate.</p>",
"locationName":"certificateArn"
},
"State":{
"shape":"String",
"documentation":"<p>The current state of the customer gateway (<code>pending | available | deleting | deleted</code>).</p>",
@ -10774,6 +10826,53 @@
}
}
},
"DescribeExportImageTasksMaxResults":{
"type":"integer",
"max":500,
"min":1
},
"DescribeExportImageTasksRequest":{
"type":"structure",
"members":{
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>Filter tasks using the <code>task-state</code> filter and one of the following values: <code>active</code>, <code>completed</code>, <code>deleting</code>, or <code>deleted</code>.</p>",
"locationName":"Filter"
},
"ExportImageTaskIds":{
"shape":"ExportImageTaskIdList",
"documentation":"<p>The IDs of the export image tasks.</p>",
"locationName":"ExportImageTaskId"
},
"MaxResults":{
"shape":"DescribeExportImageTasksMaxResults",
"documentation":"<p>The maximum number of results to return in a single call.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token that indicates the next page of results.</p>"
}
}
},
"DescribeExportImageTasksResult":{
"type":"structure",
"members":{
"ExportImageTasks":{
"shape":"ExportImageTaskList",
"documentation":"<p>Information about the export image tasks.</p>",
"locationName":"exportImageTaskSet"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token to use to get the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
"locationName":"nextToken"
}
}
},
"DescribeExportTasksRequest":{
"type":"structure",
"members":{
@ -11426,16 +11525,16 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>Filter tasks using the <code>task-state</code> filter and one of the following values: active, completed, deleting, deleted.</p>"
"documentation":"<p>Filter tasks using the <code>task-state</code> filter and one of the following values: <code>active</code>, <code>completed</code>, <code>deleting</code>, or <code>deleted</code>.</p>"
},
"ImportTaskIds":{
"shape":"ImportTaskIdList",
"documentation":"<p>A list of import image task IDs.</p>",
"documentation":"<p>The IDs of the import image tasks.</p>",
"locationName":"ImportTaskId"
},
"MaxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>"
"documentation":"<p>The maximum number of results to return in a single call.</p>"
},
"NextToken":{
"shape":"String",
@ -14099,7 +14198,7 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>service-name</code>: The name of the service.</p> </li> <li> <p> <code>vpc-id</code>: The ID of the VPC in which the endpoint resides.</p> </li> <li> <p> <code>vpc-endpoint-id</code>: The ID of the endpoint.</p> </li> <li> <p> <code>vpc-endpoint-state</code>: The state of the endpoint. (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>)</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> </ul>",
"documentation":"<p>One or more filters.</p> <ul> <li> <p> <code>service-name</code>: The name of the service.</p> </li> <li> <p> <code>vpc-id</code>: The ID of the VPC in which the endpoint resides.</p> </li> <li> <p> <code>vpc-endpoint-id</code>: The ID of the endpoint.</p> </li> <li> <p> <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | <code>rejected</code> | <code>failed</code>).</p> </li> <li> <p> <code>tag</code>:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p> </li> </ul>",
"locationName":"Filter"
},
"MaxResults":{
@ -15530,6 +15629,150 @@
"microsoft"
]
},
"ExportImageRequest":{
"type":"structure",
"required":[
"DiskImageFormat",
"ImageId",
"S3ExportLocation"
],
"members":{
"ClientToken":{
"shape":"String",
"documentation":"<p>Token to enable idempotency for export image requests.</p>",
"idempotencyToken":true
},
"Description":{
"shape":"String",
"documentation":"<p>A description of the image being exported. The maximum length is 255 bytes.</p>"
},
"DiskImageFormat":{
"shape":"DiskImageFormat",
"documentation":"<p>The disk image format.</p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
},
"ImageId":{
"shape":"String",
"documentation":"<p>The ID of the image.</p>"
},
"S3ExportLocation":{
"shape":"ExportTaskS3LocationRequest",
"documentation":"<p>Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.</p>"
},
"RoleName":{
"shape":"String",
"documentation":"<p>The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.</p>"
}
}
},
"ExportImageResult":{
"type":"structure",
"members":{
"Description":{
"shape":"String",
"documentation":"<p>A description of the image being exported.</p>",
"locationName":"description"
},
"DiskImageFormat":{
"shape":"DiskImageFormat",
"documentation":"<p>The disk image format for the exported image.</p>",
"locationName":"diskImageFormat"
},
"ExportImageTaskId":{
"shape":"String",
"documentation":"<p>The ID of the export image task.</p>",
"locationName":"exportImageTaskId"
},
"ImageId":{
"shape":"String",
"documentation":"<p>The ID of the image.</p>",
"locationName":"imageId"
},
"RoleName":{
"shape":"String",
"documentation":"<p>The name of the role that grants VM Import/Export permission to export images to your S3 bucket.</p>",
"locationName":"roleName"
},
"Progress":{
"shape":"String",
"documentation":"<p>The percent complete of the export image task.</p>",
"locationName":"progress"
},
"S3ExportLocation":{
"shape":"ExportTaskS3Location",
"documentation":"<p>Information about the destination S3 bucket.</p>",
"locationName":"s3ExportLocation"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the export image task. The possible values are <code>active</code>, <code>completed</code>, <code>deleting</code>, and <code>deleted</code>.</p>",
"locationName":"status"
},
"StatusMessage":{
"shape":"String",
"documentation":"<p>The status message for the export image task.</p>",
"locationName":"statusMessage"
}
}
},
"ExportImageTask":{
"type":"structure",
"members":{
"Description":{
"shape":"String",
"documentation":"<p>A description of the image being exported.</p>",
"locationName":"description"
},
"ExportImageTaskId":{
"shape":"String",
"documentation":"<p>The ID of the export image task.</p>",
"locationName":"exportImageTaskId"
},
"ImageId":{
"shape":"String",
"documentation":"<p>The ID of the image.</p>",
"locationName":"imageId"
},
"Progress":{
"shape":"String",
"documentation":"<p>The percent complete of the export image task.</p>",
"locationName":"progress"
},
"S3ExportLocation":{
"shape":"ExportTaskS3Location",
"documentation":"<p>Information about the destination S3 bucket.</p>",
"locationName":"s3ExportLocation"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the export image task. The possible values are <code>active</code>, <code>completed</code>, <code>deleting</code>, and <code>deleted</code>.</p>",
"locationName":"status"
},
"StatusMessage":{
"shape":"String",
"documentation":"<p>The status message for the export image task.</p>",
"locationName":"statusMessage"
}
},
"documentation":"<p>Describes an export image task.</p>"
},
"ExportImageTaskIdList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"ExportImageTaskId"
}
},
"ExportImageTaskList":{
"type":"list",
"member":{
"shape":"ExportImageTask",
"locationName":"item"
}
},
"ExportTask":{
"type":"structure",
"members":{
@ -15580,6 +15823,37 @@
"locationName":"item"
}
},
"ExportTaskS3Location":{
"type":"structure",
"members":{
"S3Bucket":{
"shape":"String",
"documentation":"<p>The destination S3 bucket.</p>",
"locationName":"s3Bucket"
},
"S3Prefix":{
"shape":"String",
"documentation":"<p>The prefix (logical hierarchy) in the bucket.</p>",
"locationName":"s3Prefix"
}
},
"documentation":"<p>Describes the destination for an export image task.</p>"
},
"ExportTaskS3LocationRequest":{
"type":"structure",
"required":["S3Bucket"],
"members":{
"S3Bucket":{
"shape":"String",
"documentation":"<p>The destination S3 bucket.</p>"
},
"S3Prefix":{
"shape":"String",
"documentation":"<p>The prefix (logical hierarchy) in the bucket.</p>"
}
},
"documentation":"<p>Describes the destination for an export image task.</p>"
},
"ExportTaskState":{
"type":"string",
"enum":[
@ -15703,8 +15977,8 @@
"type":"string",
"enum":[
"error",
"pending-fulfillment",
"pending-termination",
"pending_fulfillment",
"pending_termination",
"fulfilled"
]
},
@ -16029,8 +16303,8 @@
"active",
"deleted",
"failed",
"deleted-running",
"deleted-terminating",
"deleted_running",
"deleted_terminating",
"modifying"
]
},
@ -16100,6 +16374,11 @@
"shape":"String",
"documentation":"<p>Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.</p>",
"locationName":"logDestination"
},
"LogFormat":{
"shape":"String",
"documentation":"<p>The format of the flow log record.</p>",
"locationName":"logFormat"
}
},
"documentation":"<p>Describes a flow log.</p>"
@ -17173,6 +17452,41 @@
"xen"
]
},
"IKEVersionsList":{
"type":"list",
"member":{
"shape":"IKEVersionsListValue",
"locationName":"item"
}
},
"IKEVersionsListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The IKE version.</p>",
"locationName":"value"
}
},
"documentation":"<p>The internet key exchange (IKE) version permitted for the VPN tunnel.</p>"
},
"IKEVersionsRequestList":{
"type":"list",
"member":{
"shape":"IKEVersionsRequestListValue",
"locationName":"item"
}
},
"IKEVersionsRequestListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The IKE version.</p>"
}
},
"documentation":"<p>The IKE version that is permitted for the VPN tunnel.</p>"
},
"IamInstanceProfile":{
"type":"structure",
"members":{
@ -19410,6 +19724,12 @@
"g3.8xlarge",
"g3.16xlarge",
"g3s.xlarge",
"g4dn.xlarge",
"g4dn.2xlarge",
"g4dn.4xlarge",
"g4dn.8xlarge",
"g4dn.12xlarge",
"g4dn.16xlarge",
"cg1.4xlarge",
"p2.xlarge",
"p2.8xlarge",
@ -20077,7 +20397,7 @@
},
"ThreadsPerCore":{
"shape":"Integer",
"documentation":"<p>The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.</p>"
"documentation":"<p>The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.</p>"
}
},
"documentation":"<p>The CPU options for the instance. Both the core count and threads per core must be specified in the request.</p>"
@ -22012,7 +22332,7 @@
},
"PolicyDocument":{
"shape":"String",
"documentation":"<p>A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.</p>"
"documentation":"<p>A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.</p>"
},
"AddRouteTableIds":{
"shape":"ValueStringList",
@ -22211,6 +22531,10 @@
"shape":"String",
"documentation":"<p>The ID of the transit gateway.</p>"
},
"CustomerGatewayId":{
"shape":"String",
"documentation":"<p>The ID of the customer gateway at your end of the VPN connection.</p>"
},
"VpnGatewayId":{
"shape":"String",
"documentation":"<p>The ID of the virtual private gateway at the AWS side of the VPN connection.</p>"
@ -22230,6 +22554,144 @@
}
}
},
"ModifyVpnTunnelCertificateRequest":{
"type":"structure",
"required":[
"VpnConnectionId",
"VpnTunnelOutsideIpAddress"
],
"members":{
"VpnConnectionId":{
"shape":"String",
"documentation":"<p>The ID of the AWS Site-to-Site VPN connection.</p>"
},
"VpnTunnelOutsideIpAddress":{
"shape":"String",
"documentation":"<p>The external IP address of the VPN tunnel.</p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
}
}
},
"ModifyVpnTunnelCertificateResult":{
"type":"structure",
"members":{
"VpnConnection":{
"shape":"VpnConnection",
"locationName":"vpnConnection"
}
}
},
"ModifyVpnTunnelOptionsRequest":{
"type":"structure",
"required":[
"VpnConnectionId",
"VpnTunnelOutsideIpAddress",
"TunnelOptions"
],
"members":{
"VpnConnectionId":{
"shape":"String",
"documentation":"<p>The ID of the AWS Site-to-Site VPN connection.</p>"
},
"VpnTunnelOutsideIpAddress":{
"shape":"String",
"documentation":"<p>The external IP address of the VPN tunnel.</p>"
},
"TunnelOptions":{
"shape":"ModifyVpnTunnelOptionsSpecification",
"documentation":"<p>The tunnel options to modify.</p>"
},
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
}
}
},
"ModifyVpnTunnelOptionsResult":{
"type":"structure",
"members":{
"VpnConnection":{
"shape":"VpnConnection",
"locationName":"vpnConnection"
}
}
},
"ModifyVpnTunnelOptionsSpecification":{
"type":"structure",
"members":{
"TunnelInsideCidr":{
"shape":"String",
"documentation":"<p>The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway. </p> <p>Constraints: A size /30 CIDR block from the <code>169.254.0.0/16</code> range. The following CIDR blocks are reserved and cannot be used:</p> <ul> <li> <p> <code>169.254.0.0/30</code> </p> </li> <li> <p> <code>169.254.1.0/30</code> </p> </li> <li> <p> <code>169.254.2.0/30</code> </p> </li> <li> <p> <code>169.254.3.0/30</code> </p> </li> <li> <p> <code>169.254.4.0/30</code> </p> </li> <li> <p> <code>169.254.5.0/30</code> </p> </li> <li> <p> <code>169.254.169.252/30</code> </p> </li> </ul>"
},
"PreSharedKey":{
"shape":"String",
"documentation":"<p>The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.</p> <p>Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).</p>"
},
"Phase1LifetimeSeconds":{
"shape":"Integer",
"documentation":"<p>The lifetime for phase 1 of the IKE negotiation, in seconds.</p> <p>Constraints: A value between 900 and 28,800.</p> <p>Default: <code>28800</code> </p>"
},
"Phase2LifetimeSeconds":{
"shape":"Integer",
"documentation":"<p>The lifetime for phase 2 of the IKE negotiation, in seconds.</p> <p>Constraints: A value between 900 and 3,600. The value must be less than the value for <code>Phase1LifetimeSeconds</code>.</p> <p>Default: <code>3600</code> </p>"
},
"RekeyMarginTimeSeconds":{
"shape":"Integer",
"documentation":"<p>The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for <code>RekeyFuzzPercentage</code>.</p> <p>Constraints: A value between 60 and half of <code>Phase2LifetimeSeconds</code>.</p> <p>Default: <code>540</code> </p>"
},
"RekeyFuzzPercentage":{
"shape":"Integer",
"documentation":"<p>The percentage of the rekey window (determined by <code>RekeyMarginTimeSeconds</code>) during which the rekey time is randomly selected.</p> <p>Constraints: A value between 0 and 100.</p> <p>Default: <code>100</code> </p>"
},
"ReplayWindowSize":{
"shape":"Integer",
"documentation":"<p>The number of packets in an IKE replay window.</p> <p>Constraints: A value between 64 and 2048.</p> <p>Default: <code>1024</code> </p>"
},
"DPDTimeoutSeconds":{
"shape":"Integer",
"documentation":"<p>The number of seconds after which a DPD timeout occurs.</p> <p>Constraints: A value between 0 and 30.</p> <p>Default: <code>30</code> </p>"
},
"Phase1EncryptionAlgorithms":{
"shape":"Phase1EncryptionAlgorithmsRequestList",
"documentation":"<p>One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>AES128</code> | <code>AES256</code> </p>",
"locationName":"Phase1EncryptionAlgorithm"
},
"Phase2EncryptionAlgorithms":{
"shape":"Phase2EncryptionAlgorithmsRequestList",
"documentation":"<p>One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>AES128</code> | <code>AES256</code> </p>",
"locationName":"Phase2EncryptionAlgorithm"
},
"Phase1IntegrityAlgorithms":{
"shape":"Phase1IntegrityAlgorithmsRequestList",
"documentation":"<p>One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>SHA1</code> | <code>SHA2-256</code> </p>",
"locationName":"Phase1IntegrityAlgorithm"
},
"Phase2IntegrityAlgorithms":{
"shape":"Phase2IntegrityAlgorithmsRequestList",
"documentation":"<p>One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>SHA1</code> | <code>SHA2-256</code> </p>",
"locationName":"Phase2IntegrityAlgorithm"
},
"Phase1DHGroupNumbers":{
"shape":"Phase1DHGroupNumbersRequestList",
"documentation":"<p>One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>2</code> | <code>14</code> | <code>15</code> | <code>16</code> | <code>17</code> | <code>18</code> | <code>22</code> | <code>23</code> | <code>24</code> </p>",
"locationName":"Phase1DHGroupNumber"
},
"Phase2DHGroupNumbers":{
"shape":"Phase2DHGroupNumbersRequestList",
"documentation":"<p>One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>2</code> | <code>5</code> | <code>14</code> | <code>15</code> | <code>16</code> | <code>17</code> | <code>18</code> | <code>22</code> | <code>23</code> | <code>24</code> </p>",
"locationName":"Phase2DHGroupNumber"
},
"IKEVersions":{
"shape":"IKEVersionsRequestList",
"documentation":"<p>The IKE versions that are permitted for the VPN tunnel.</p> <p>Valid values: <code>ikev1</code> | <code>ikev2</code> </p>",
"locationName":"IKEVersion"
}
},
"documentation":"<p>The AWS Site-to-Site VPN tunnel options to modify.</p>"
},
"MonitorInstancesRequest":{
"type":"structure",
"required":["InstanceIds"],
@ -23143,6 +23605,216 @@
"type":"string",
"enum":["all"]
},
"Phase1DHGroupNumbersList":{
"type":"list",
"member":{
"shape":"Phase1DHGroupNumbersListValue",
"locationName":"item"
}
},
"Phase1DHGroupNumbersListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"Integer",
"documentation":"<p>The Diffie-Hellmann group number.</p>",
"locationName":"value"
}
},
"documentation":"<p>The Diffie-Hellmann group number for phase 1 IKE negotiations.</p>"
},
"Phase1DHGroupNumbersRequestList":{
"type":"list",
"member":{
"shape":"Phase1DHGroupNumbersRequestListValue",
"locationName":"item"
}
},
"Phase1DHGroupNumbersRequestListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"Integer",
"documentation":"<p>The Diffie-Hellmann group number.</p>"
}
},
"documentation":"<p>Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.</p>"
},
"Phase1EncryptionAlgorithmsList":{
"type":"list",
"member":{
"shape":"Phase1EncryptionAlgorithmsListValue",
"locationName":"item"
}
},
"Phase1EncryptionAlgorithmsListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The value for the encryption algorithm.</p>",
"locationName":"value"
}
},
"documentation":"<p>The encryption algorithm for phase 1 IKE negotiations.</p>"
},
"Phase1EncryptionAlgorithmsRequestList":{
"type":"list",
"member":{
"shape":"Phase1EncryptionAlgorithmsRequestListValue",
"locationName":"item"
}
},
"Phase1EncryptionAlgorithmsRequestListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The value for the encryption algorithm.</p>"
}
},
"documentation":"<p>Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.</p>"
},
"Phase1IntegrityAlgorithmsList":{
"type":"list",
"member":{
"shape":"Phase1IntegrityAlgorithmsListValue",
"locationName":"item"
}
},
"Phase1IntegrityAlgorithmsListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The value for the integrity algorithm.</p>",
"locationName":"value"
}
},
"documentation":"<p>The integrity algorithm for phase 1 IKE negotiations.</p>"
},
"Phase1IntegrityAlgorithmsRequestList":{
"type":"list",
"member":{
"shape":"Phase1IntegrityAlgorithmsRequestListValue",
"locationName":"item"
}
},
"Phase1IntegrityAlgorithmsRequestListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The value for the integrity algorithm.</p>"
}
},
"documentation":"<p>Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.</p>"
},
"Phase2DHGroupNumbersList":{
"type":"list",
"member":{
"shape":"Phase2DHGroupNumbersListValue",
"locationName":"item"
}
},
"Phase2DHGroupNumbersListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"Integer",
"documentation":"<p>The Diffie-Hellmann group number.</p>",
"locationName":"value"
}
},
"documentation":"<p>The Diffie-Hellmann group number for phase 2 IKE negotiations.</p>"
},
"Phase2DHGroupNumbersRequestList":{
"type":"list",
"member":{
"shape":"Phase2DHGroupNumbersRequestListValue",
"locationName":"item"
}
},
"Phase2DHGroupNumbersRequestListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"Integer",
"documentation":"<p>The Diffie-Hellmann group number.</p>"
}
},
"documentation":"<p>Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.</p>"
},
"Phase2EncryptionAlgorithmsList":{
"type":"list",
"member":{
"shape":"Phase2EncryptionAlgorithmsListValue",
"locationName":"item"
}
},
"Phase2EncryptionAlgorithmsListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The encryption algorithm.</p>",
"locationName":"value"
}
},
"documentation":"<p>The encryption algorithm for phase 2 IKE negotiations.</p>"
},
"Phase2EncryptionAlgorithmsRequestList":{
"type":"list",
"member":{
"shape":"Phase2EncryptionAlgorithmsRequestListValue",
"locationName":"item"
}
},
"Phase2EncryptionAlgorithmsRequestListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The encryption algorithm.</p>"
}
},
"documentation":"<p>Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.</p>"
},
"Phase2IntegrityAlgorithmsList":{
"type":"list",
"member":{
"shape":"Phase2IntegrityAlgorithmsListValue",
"locationName":"item"
}
},
"Phase2IntegrityAlgorithmsListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The integrity algorithm.</p>",
"locationName":"value"
}
},
"documentation":"<p>The integrity algorithm for phase 2 IKE negotiations.</p>"
},
"Phase2IntegrityAlgorithmsRequestList":{
"type":"list",
"member":{
"shape":"Phase2IntegrityAlgorithmsRequestListValue",
"locationName":"item"
}
},
"Phase2IntegrityAlgorithmsRequestListValue":{
"type":"structure",
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The integrity algorithm.</p>"
}
},
"documentation":"<p>Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.</p>"
},
"Placement":{
"type":"structure",
"members":{
@ -27705,7 +28377,7 @@
"members":{
"AllocationStrategy":{
"shape":"AllocationStrategy",
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.</p> <p>If the allocation strategy is <code>lowestPrice</code>, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, Spot Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p>",
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.</p> <p>If the allocation strategy is <code>lowestPrice</code>, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, Spot Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p>",
"locationName":"allocationStrategy"
},
"OnDemandAllocationStrategy":{
@ -28054,7 +28726,7 @@
"members":{
"AllocationStrategy":{
"shape":"SpotAllocationStrategy",
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.</p> <p>If the allocation strategy is <code>lowestPrice</code>, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, EC2 Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p>",
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.</p> <p>If the allocation strategy is <code>lowestPrice</code>, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, EC2 Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p>",
"locationName":"allocationStrategy"
},
"InstanceInterruptionBehavior":{
@ -28095,7 +28767,7 @@
"members":{
"AllocationStrategy":{
"shape":"SpotAllocationStrategy",
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.</p> <p>If the allocation strategy is <code>lowestPrice</code>, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, EC2 Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools that are optimally chosen based on the available Spot Instance capacity.</p>"
"documentation":"<p>Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.</p> <p>If the allocation strategy is <code>lowestPrice</code>, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.</p> <p>If the allocation strategy is <code>diversified</code>, EC2 Fleet launches instances from all the Spot Instance pools that you specify.</p> <p>If the allocation strategy is <code>capacityOptimized</code>, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.</p>"
},
"InstanceInterruptionBehavior":{
"shape":"SpotInstanceInterruptionBehavior",
@ -29936,10 +30608,96 @@
"udp"
]
},
"TunnelOption":{
"type":"structure",
"members":{
"OutsideIpAddress":{
"shape":"String",
"documentation":"<p>The external IP address of the VPN tunnel.</p>",
"locationName":"outsideIpAddress"
},
"TunnelInsideCidr":{
"shape":"String",
"documentation":"<p>The range of inside IP addresses for the tunnel.</p>",
"locationName":"tunnelInsideCidr"
},
"PreSharedKey":{
"shape":"String",
"documentation":"<p>The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.</p>",
"locationName":"preSharedKey"
},
"Phase1LifetimeSeconds":{
"shape":"Integer",
"documentation":"<p>The lifetime for phase 1 of the IKE negotiation, in seconds.</p>",
"locationName":"phase1LifetimeSeconds"
},
"Phase2LifetimeSeconds":{
"shape":"Integer",
"documentation":"<p>The lifetime for phase 2 of the IKE negotiation, in seconds.</p>",
"locationName":"phase2LifetimeSeconds"
},
"RekeyMarginTimeSeconds":{
"shape":"Integer",
"documentation":"<p>The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.</p>",
"locationName":"rekeyMarginTimeSeconds"
},
"RekeyFuzzPercentage":{
"shape":"Integer",
"documentation":"<p>The percentage of the rekey window determined by <code>RekeyMarginTimeSeconds</code> during which the rekey time is randomly selected.</p>",
"locationName":"rekeyFuzzPercentage"
},
"ReplayWindowSize":{
"shape":"Integer",
"documentation":"<p>The number of packets in an IKE replay window.</p>",
"locationName":"replayWindowSize"
},
"DpdTimeoutSeconds":{
"shape":"Integer",
"documentation":"<p>The number of seconds after which a DPD timeout occurs.</p>",
"locationName":"dpdTimeoutSeconds"
},
"Phase1EncryptionAlgorithms":{
"shape":"Phase1EncryptionAlgorithmsList",
"documentation":"<p>The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.</p>",
"locationName":"phase1EncryptionAlgorithmSet"
},
"Phase2EncryptionAlgorithms":{
"shape":"Phase2EncryptionAlgorithmsList",
"documentation":"<p>The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.</p>",
"locationName":"phase2EncryptionAlgorithmSet"
},
"Phase1IntegrityAlgorithms":{
"shape":"Phase1IntegrityAlgorithmsList",
"documentation":"<p>The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.</p>",
"locationName":"phase1IntegrityAlgorithmSet"
},
"Phase2IntegrityAlgorithms":{
"shape":"Phase2IntegrityAlgorithmsList",
"documentation":"<p>The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.</p>",
"locationName":"phase2IntegrityAlgorithmSet"
},
"Phase1DHGroupNumbers":{
"shape":"Phase1DHGroupNumbersList",
"documentation":"<p>The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.</p>",
"locationName":"phase1DHGroupNumberSet"
},
"Phase2DHGroupNumbers":{
"shape":"Phase2DHGroupNumbersList",
"documentation":"<p>The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.</p>",
"locationName":"phase2DHGroupNumberSet"
},
"IkeVersions":{
"shape":"IKEVersionsList",
"documentation":"<p>The IKE versions that are permitted for the VPN tunnel.</p>",
"locationName":"ikeVersionSet"
}
},
"documentation":"<p>The VPN tunnel options.</p>"
},
"TunnelOptionsList":{
"type":"list",
"member":{
"shape":"VpnTunnelOptionsSpecification",
"shape":"TunnelOption",
"locationName":"item"
}
},
@ -30336,6 +31094,11 @@
"shape":"String",
"documentation":"<p>If an error occurs, a description of the error.</p>",
"locationName":"statusMessage"
},
"CertificateArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.</p>",
"locationName":"certificateArn"
}
},
"documentation":"<p>Describes telemetry for a VPN tunnel.</p>"
@ -31371,6 +32134,11 @@
"shape":"Boolean",
"documentation":"<p>Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.</p>",
"locationName":"staticRoutesOnly"
},
"TunnelOptions":{
"shape":"TunnelOptionsList",
"documentation":"<p>Indicates the VPN tunnel options.</p>",
"locationName":"tunnelOptionSet"
}
},
"documentation":"<p>Describes VPN connection options.</p>"
@ -31384,7 +32152,7 @@
"locationName":"staticRoutesOnly"
},
"TunnelOptions":{
"shape":"TunnelOptionsList",
"shape":"VpnTunnelOptionsSpecificationsList",
"documentation":"<p>The tunnel options for the VPN connection.</p>"
}
},
@ -31506,11 +32274,74 @@
},
"PreSharedKey":{
"shape":"String",
"documentation":"<p>The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.</p> <p>Constraints: Allowed characters are alphanumeric characters and ._. Must be between 8 and 64 characters in length and cannot start with zero (0).</p>"
"documentation":"<p>The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.</p> <p>Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).</p>"
},
"Phase1LifetimeSeconds":{
"shape":"Integer",
"documentation":"<p>The lifetime for phase 1 of the IKE negotiation, in seconds.</p> <p>Constraints: A value between 900 and 28,800.</p> <p>Default: <code>28800</code> </p>"
},
"Phase2LifetimeSeconds":{
"shape":"Integer",
"documentation":"<p>The lifetime for phase 2 of the IKE negotiation, in seconds.</p> <p>Constraints: A value between 900 and 3,600. The value must be less than the value for <code>Phase1LifetimeSeconds</code>.</p> <p>Default: <code>3600</code> </p>"
},
"RekeyMarginTimeSeconds":{
"shape":"Integer",
"documentation":"<p>The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for <code>RekeyFuzzPercentage</code>.</p> <p>Constraints: A value between 60 and half of <code>Phase2LifetimeSeconds</code>.</p> <p>Default: <code>540</code> </p>"
},
"RekeyFuzzPercentage":{
"shape":"Integer",
"documentation":"<p>The percentage of the rekey window (determined by <code>RekeyMarginTimeSeconds</code>) during which the rekey time is randomly selected.</p> <p>Constraints: A value between 0 and 100.</p> <p>Default: <code>100</code> </p>"
},
"ReplayWindowSize":{
"shape":"Integer",
"documentation":"<p>The number of packets in an IKE replay window.</p> <p>Constraints: A value between 64 and 2048.</p> <p>Default: <code>1024</code> </p>"
},
"DPDTimeoutSeconds":{
"shape":"Integer",
"documentation":"<p>The number of seconds after which a DPD timeout occurs.</p> <p>Constraints: A value between 0 and 30.</p> <p>Default: <code>30</code> </p>"
},
"Phase1EncryptionAlgorithms":{
"shape":"Phase1EncryptionAlgorithmsRequestList",
"documentation":"<p>One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>AES128</code> | <code>AES256</code> </p>",
"locationName":"Phase1EncryptionAlgorithm"
},
"Phase2EncryptionAlgorithms":{
"shape":"Phase2EncryptionAlgorithmsRequestList",
"documentation":"<p>One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>AES128</code> | <code>AES256</code> </p>",
"locationName":"Phase2EncryptionAlgorithm"
},
"Phase1IntegrityAlgorithms":{
"shape":"Phase1IntegrityAlgorithmsRequestList",
"documentation":"<p>One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>SHA1</code> | <code>SHA2-256</code> </p>",
"locationName":"Phase1IntegrityAlgorithm"
},
"Phase2IntegrityAlgorithms":{
"shape":"Phase2IntegrityAlgorithmsRequestList",
"documentation":"<p>One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>SHA1</code> | <code>SHA2-256</code> </p>",
"locationName":"Phase2IntegrityAlgorithm"
},
"Phase1DHGroupNumbers":{
"shape":"Phase1DHGroupNumbersRequestList",
"documentation":"<p>One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>2</code> | <code>14</code> | <code>15</code> | <code>16</code> | <code>17</code> | <code>18</code> | <code>22</code> | <code>23</code> | <code>24</code> </p>",
"locationName":"Phase1DHGroupNumber"
},
"Phase2DHGroupNumbers":{
"shape":"Phase2DHGroupNumbersRequestList",
"documentation":"<p>One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>2</code> | <code>5</code> | <code>14</code> | <code>15</code> | <code>16</code> | <code>17</code> | <code>18</code> | <code>22</code> | <code>23</code> | <code>24</code> </p>",
"locationName":"Phase2DHGroupNumber"
},
"IKEVersions":{
"shape":"IKEVersionsRequestList",
"documentation":"<p>The IKE versions that are permitted for the VPN tunnel.</p> <p>Valid values: <code>ikev1</code> | <code>ikev2</code> </p>",
"locationName":"IKEVersion"
}
},
"documentation":"<p>The tunnel options for a VPN connection.</p>"
},
"VpnTunnelOptionsSpecificationsList":{
"type":"list",
"member":{"shape":"VpnTunnelOptionsSpecification"}
},
"WithdrawByoipCidrRequest":{
"type":"structure",
"required":["Cidr"],

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

File diff suppressed because one or more lines are too long

185
botocore/data/eks/2017-11-01/service-2.json
View file

@ -97,6 +97,20 @@
],
"documentation":"<p>Lists the Amazon EKS clusters in your AWS account in the specified Region.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>List the tags for an Amazon EKS resource.</p>"
},
"ListUpdates":{
"name":"ListUpdates",
"http":{
@ -113,6 +127,34 @@
],
"documentation":"<p>Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Deletes specified tags from a resource.</p>"
},
"UpdateClusterConfig":{
"name":"UpdateClusterConfig",
"http":{
@ -151,6 +193,15 @@
}
},
"shapes":{
"BadRequestException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"Boolean":{"type":"boolean"},
"BoxedBoolean":{
"type":"boolean",
@ -214,6 +265,10 @@
"shape":"Logging",
"documentation":"<p>The logging configuration for your cluster.</p>"
},
"identity":{
"shape":"Identity",
"documentation":"<p>The identity provider information for the cluster.</p>"
},
"status":{
"shape":"ClusterStatus",
"documentation":"<p>The current status of the cluster.</p>"
@ -229,6 +284,10 @@
"platformVersion":{
"shape":"String",
"documentation":"<p>The platform version of your Amazon EKS cluster. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html\">Platform Versions</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.</p>"
}
},
"documentation":"<p>An object representing an Amazon EKS cluster.</p>"
@ -280,6 +339,10 @@
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"idempotencyToken":true
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.</p>"
}
}
},
@ -399,6 +462,16 @@
"type":"list",
"member":{"shape":"ErrorDetail"}
},
"Identity":{
"type":"structure",
"members":{
"oidc":{
"shape":"OIDC",
"documentation":"<p>The <a href=\"https://openid.net/connect/\">OpenID Connect</a> identity provider information for the cluster.</p>"
}
},
"documentation":"<p>An object representing an identity provider for authentication credentials.</p>"
},
"InvalidParameterException":{
"type":"structure",
"members":{
@ -461,6 +534,27 @@
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters.</p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the resource.</p>"
}
}
},
"ListUpdatesRequest":{
"type":"structure",
"required":["name"],
@ -546,6 +640,25 @@
},
"documentation":"<p>An object representing the logging configuration for resources in your cluster.</p>"
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>A service resource associated with the request could not be found. Clients should not retry such requests.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"OIDC":{
"type":"structure",
"members":{
"issuer":{
"shape":"String",
"documentation":"<p>The issuer URL for the OpenID Connect identity provider.</p>"
}
},
"documentation":"<p>An object representing the <a href=\"https://openid.net/connect/\">OpenID Connect</a> identity provider information for the cluster.</p>"
},
"ResourceInUseException":{
"type":"structure",
"members":{
@ -614,6 +727,52 @@
"type":"list",
"member":{"shape":"String"}
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"TagMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":50,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags to add to the resource. A tag is an array of key-value pairs.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256
},
"Timestamp":{"type":"timestamp"},
"UnsupportedAvailabilityZoneException":{
"type":"structure",
@ -632,6 +791,32 @@
"error":{"httpStatusCode":400},
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of the tags to be removed.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"Update":{
"type":"structure",
"members":{

48
botocore/data/elasticache/2015-02-02/service-2.json
View file

@ -643,6 +643,7 @@
{"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"},
{"shape":"NodeQuotaForCustomerExceededFault"},
{"shape":"NoOperationFault"},
{"shape":"InvalidKMSKeyFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -665,7 +666,7 @@
{"shape":"InvalidParameterCombinationException"},
{"shape":"InvalidParameterValueException"}
],
"documentation":"<p>Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.</p> <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> operations to scale up your cluster or replication group, the value of the <code>CacheNodeType</code> parameter must be one of the node types returned by this operation.</p>"
"documentation":"<p>Lists all available node types that you can scale your Redis cluster's or replication group's current node type.</p> <p>When you use the <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code> operations to scale your cluster or replication group, the value of the <code>CacheNodeType</code> parameter must be one of the node types returned by this operation.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -772,6 +773,7 @@
{"shape":"CacheSecurityGroupNotFoundFault"},
{"shape":"CacheParameterGroupNotFoundFault"},
{"shape":"InvalidVPCNetworkStateFault"},
{"shape":"InvalidKMSKeyFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -796,6 +798,7 @@
{"shape":"InsufficientCacheClusterCapacityFault"},
{"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"},
{"shape":"NodeQuotaForCustomerExceededFault"},
{"shape":"InvalidKMSKeyFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -914,6 +917,7 @@
{"shape":"NodeGroupNotFoundFault"},
{"shape":"ReplicationGroupNotFoundFault"},
{"shape":"TestFailoverNotAvailableFault"},
{"shape":"InvalidKMSKeyFault"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
@ -970,6 +974,10 @@
"ScaleUpModifications":{
"shape":"NodeTypeList",
"documentation":"<p>A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.</p> <p>When scaling up a Redis cluster or replication group using <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code>, use a value from this list for the <code>CacheNodeType</code> parameter.</p>"
},
"ScaleDownModifications":{
"shape":"NodeTypeList",
"documentation":"<p>A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.</p> <p>When scaling down on a Redis cluster or replication group using <code>ModifyCacheCluster</code> or <code>ModifyReplicationGroup</code>, use a value from this list for the <code>CacheNodeType</code> parameter.</p>"
}
},
"documentation":"<p>Represents the allowed node types you can use to modify your cluster or replication group.</p>"
@ -1805,6 +1813,10 @@
"TargetBucket":{
"shape":"String",
"documentation":"<p>The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.</p> <p>When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html#backups-exporting-grant-access\">Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket</a> in the <i>Amazon ElastiCache User Guide</i>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Snapshots.Exporting.html\">Exporting a Snapshot</a> in the <i>Amazon ElastiCache User Guide</i>.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The ID of the KMS key used to encrypt the target snapshot.</p>"
}
},
"documentation":"<p>Represents the input of a <code>CopySnapshotMessage</code> operation.</p>"
@ -1821,7 +1833,7 @@
"members":{
"CacheClusterId":{
"shape":"String",
"documentation":"<p>The node group (shard) identifier. This parameter is stored as a lowercase string.</p> <p> <b>Constraints:</b> </p> <ul> <li> <p>A name must contain from 1 to 20 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
"documentation":"<p>The node group (shard) identifier. This parameter is stored as a lowercase string.</p> <p> <b>Constraints:</b> </p> <ul> <li> <p>A name must contain from 1 to 50 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"ReplicationGroupId":{
"shape":"String",
@ -2011,7 +2023,7 @@
"members":{
"ReplicationGroupId":{
"shape":"String",
"documentation":"<p>The replication group identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>A name must contain from 1 to 20 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
"documentation":"<p>The replication group identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>A name must contain from 1 to 40 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"ReplicationGroupDescription":{
"shape":"String",
@ -2115,11 +2127,15 @@
},
"TransitEncryptionEnabled":{
"shape":"BooleanOptional",
"documentation":"<p>A flag that enables in-transit encryption when set to <code>true</code>.</p> <p>You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p>This parameter is valid only if the <code>Engine</code> parameter is <code>redis</code>, the <code>EngineVersion</code> parameter is <code>3.2.6</code> or <code>4.x</code>, and the cluster is being created in an Amazon VPC.</p> <p>If you enable in-transit encryption, you must also specify a value for <code>CacheSubnetGroup</code>.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p> <important> <p>For HIPAA compliance, you must specify <code>TransitEncryptionEnabled</code> as <code>true</code>, an <code>AuthToken</code>, and a <code>CacheSubnetGroup</code>.</p> </important>"
"documentation":"<p>A flag that enables in-transit encryption when set to <code>true</code>.</p> <p>You cannot modify the value of <code>TransitEncryptionEnabled</code> after the cluster is created. To enable in-transit encryption on a cluster you must set <code>TransitEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p>This parameter is valid only if the <code>Engine</code> parameter is <code>redis</code>, the <code>EngineVersion</code> parameter is <code>3.2.6</code>, <code>4.x</code> or later, and the cluster is being created in an Amazon VPC.</p> <p>If you enable in-transit encryption, you must also specify a value for <code>CacheSubnetGroup</code>.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p> <important> <p>For HIPAA compliance, you must specify <code>TransitEncryptionEnabled</code> as <code>true</code>, an <code>AuthToken</code>, and a <code>CacheSubnetGroup</code>.</p> </important>"
},
"AtRestEncryptionEnabled":{
"shape":"BooleanOptional",
"documentation":"<p>A flag that enables encryption at rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the replication group is created. To enable encryption at rest on a replication group you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create the replication group. </p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The ID of the KMS key used to encrypt the disk on the cluster.</p>"
}
},
"documentation":"<p>Represents the input of a <code>CreateReplicationGroup</code> operation.</p>"
@ -2145,6 +2161,10 @@
"SnapshotName":{
"shape":"String",
"documentation":"<p>A name for the snapshot being created.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The ID of the KMS key used to encrypt the snapshot.</p>"
}
},
"documentation":"<p>Represents the input of a <code>CreateSnapshot</code> operation.</p>"
@ -2873,6 +2893,18 @@
},
"exception":true
},
"InvalidKMSKeyFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The KMS key supplied is not valid.</p>",
"error":{
"code":"InvalidKMSKeyFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidParameterCombinationException":{
"type":"structure",
"members":{
@ -3857,6 +3889,10 @@
"AtRestEncryptionEnabled":{
"shape":"BooleanOptional",
"documentation":"<p>A flag that enables encryption at-rest when set to <code>true</code>.</p> <p>You cannot modify the value of <code>AtRestEncryptionEnabled</code> after the cluster is created. To enable encryption at-rest on a cluster you must set <code>AtRestEncryptionEnabled</code> to <code>true</code> when you create a cluster.</p> <p> <b>Required:</b> Only available when creating a replication group in an Amazon VPC using redis version <code>3.2.6</code>, <code>4.x</code> or later.</p> <p>Default: <code>false</code> </p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The ID of the KMS key used to encrypt the disk in the cluster.</p>"
}
},
"documentation":"<p>Contains all of the attributes of a specific Redis replication group.</p>",
@ -4462,6 +4498,10 @@
"NodeSnapshots":{
"shape":"NodeSnapshotList",
"documentation":"<p>A list of the cache nodes in the source cluster.</p>"
},
"KmsKeyId":{
"shape":"String",
"documentation":"<p>The ID of the KMS key used to encrypt the snapshot.</p>"
}
},
"documentation":"<p>Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.</p>",

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

@ -28,7 +28,7 @@
{"shape":"TooManyCertificatesException"},
{"shape":"CertificateNotFoundException"}
],
"documentation":"<p>Adds the specified SSL server certificate to the certificate list for the specified HTTPS listener.</p> <p>If the certificate in already in the certificate list, the call is successful but the certificate is not added again.</p> <p>To get the certificate list for a listener, use <a>DescribeListenerCertificates</a>. To remove certificates from the certificate list for a listener, use <a>RemoveListenerCertificates</a>. To replace the default certificate for a listener, use <a>ModifyListener</a>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates\">SSL Certificates</a> in the <i>Application Load Balancers Guide</i>.</p>"
"documentation":"<p>Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.</p> <p>If the certificate in already in the certificate list, the call is successful but the certificate is not added again.</p> <p>To get the certificate list for a listener, use <a>DescribeListenerCertificates</a>. To remove certificates from the certificate list for a listener, use <a>RemoveListenerCertificates</a>. To replace the default certificate for a listener, use <a>ModifyListener</a>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates\">SSL Certificates</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"AddTags":{
"name":"AddTags",
@ -264,7 +264,7 @@
"errors":[
{"shape":"ListenerNotFoundException"}
],
"documentation":"<p>Describes the default certificate and the certificate list for the specified HTTPS listener.</p> <p>If the default certificate is also in the certificate list, it appears twice in the results (once with <code>IsDefault</code> set to true and once with <code>IsDefault</code> set to false).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates\">SSL Certificates</a> in the <i>Application Load Balancers Guide</i>.</p>"
"documentation":"<p>Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.</p> <p>If the default certificate is also in the certificate list, it appears twice in the results (once with <code>IsDefault</code> set to true and once with <code>IsDefault</code> set to false).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#https-listener-certificates\">SSL Certificates</a> in the <i>Application Load Balancers Guide</i>.</p>"
},
"DescribeListeners":{
"name":"DescribeListeners",
@ -560,7 +560,7 @@
{"shape":"ListenerNotFoundException"},
{"shape":"OperationNotPermittedException"}
],
"documentation":"<p>Removes the specified certificate from the certificate list for the specified HTTPS listener.</p> <p>You can't remove the default certificate for a listener. To replace the default certificate, call <a>ModifyListener</a>.</p> <p>To list the certificates for your listener, use <a>DescribeListenerCertificates</a>.</p>"
"documentation":"<p>Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.</p> <p>You can't remove the default certificate for a listener. To replace the default certificate, call <a>ModifyListener</a>.</p> <p>To list the certificates for your listener, use <a>DescribeListenerCertificates</a>.</p>"
},
"RemoveTags":{
"name":"RemoveTags",
@ -933,11 +933,11 @@
},
"SubnetId":{
"shape":"SubnetId",
"documentation":"<p>The ID of the subnet.</p>"
"documentation":"<p>The ID of the subnet. You can specify one subnet per Availability Zone.</p>"
},
"LoadBalancerAddresses":{
"shape":"LoadBalancerAddresses",
"documentation":"<p>[Network Load Balancers] The static IP address.</p>"
"documentation":"<p>[Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create the load balancer.</p>"
}
},
"documentation":"<p>Information about an Availability Zone.</p>"
@ -1072,7 +1072,7 @@
},
"SubnetMappings":{
"shape":"SubnetMappings",
"documentation":"<p>The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.</p> <p>[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.</p> <p>[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet.</p>"
"documentation":"<p>The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.</p> <p>[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.</p> <p>[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your load balancer.</p>"
},
"SecurityGroups":{
"shape":"SecurityGroups",
@ -1159,7 +1159,7 @@
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.</p>"
"documentation":"<p>The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.</p>"
},
"HealthCheckProtocol":{
"shape":"ProtocolEnum",
@ -3024,7 +3024,7 @@
},
"Reason":{
"shape":"TargetHealthReasonEnum",
"documentation":"<p>The reason code.</p> <p>If the target state is <code>healthy</code>, a reason code is not provided.</p> <p>If the target state is <code>initial</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Elb.RegistrationInProgress</code> - The target is in the process of being registered with the load balancer.</p> </li> <li> <p> <code>Elb.InitialHealthChecking</code> - The load balancer is still sending the target the minimum number of health checks required to determine its health status.</p> </li> </ul> <p>If the target state is <code>unhealthy</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.ResponseCodeMismatch</code> - The health checks did not return an expected HTTP code.</p> </li> <li> <p> <code>Target.Timeout</code> - The health check requests timed out.</p> </li> <li> <p> <code>Target.FailedHealthChecks</code> - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.</p> </li> <li> <p> <code>Elb.InternalError</code> - The health checks failed due to an internal error.</p> </li> </ul> <p>If the target state is <code>unused</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.NotRegistered</code> - The target is not registered with the target group.</p> </li> <li> <p> <code>Target.NotInUse</code> - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.</p> </li> <li> <p> <code>Target.IpUnusable</code> - The target IP address is reserved for use by a load balancer.</p> </li> <li> <p> <code>Target.InvalidState</code> - The target is in the stopped or terminated state.</p> </li> </ul> <p>If the target state is <code>draining</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.DeregistrationInProgress</code> - The target is in the process of being deregistered and the deregistration delay period has not expired.</p> </li> </ul> <p>If the target state is <code>unavailable</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.HealthCheckDisabled</code> - Health checks are disabled for the target group.</p> </li> </ul>"
"documentation":"<p>The reason code.</p> <p>If the target state is <code>healthy</code>, a reason code is not provided.</p> <p>If the target state is <code>initial</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Elb.RegistrationInProgress</code> - The target is in the process of being registered with the load balancer.</p> </li> <li> <p> <code>Elb.InitialHealthChecking</code> - The load balancer is still sending the target the minimum number of health checks required to determine its health status.</p> </li> </ul> <p>If the target state is <code>unhealthy</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.ResponseCodeMismatch</code> - The health checks did not return an expected HTTP code.</p> </li> <li> <p> <code>Target.Timeout</code> - The health check requests timed out.</p> </li> <li> <p> <code>Target.FailedHealthChecks</code> - The load balancer received an error while establishing a connection to the target or the target response was malformed.</p> </li> <li> <p> <code>Elb.InternalError</code> - The health checks failed due to an internal error.</p> </li> </ul> <p>If the target state is <code>unused</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.NotRegistered</code> - The target is not registered with the target group.</p> </li> <li> <p> <code>Target.NotInUse</code> - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.</p> </li> <li> <p> <code>Target.IpUnusable</code> - The target IP address is reserved for use by a load balancer.</p> </li> <li> <p> <code>Target.InvalidState</code> - The target is in the stopped or terminated state.</p> </li> </ul> <p>If the target state is <code>draining</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.DeregistrationInProgress</code> - The target is in the process of being deregistered and the deregistration delay period has not expired.</p> </li> </ul> <p>If the target state is <code>unavailable</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.HealthCheckDisabled</code> - Health checks are disabled for the target group.</p> </li> </ul>"
},
"Description":{
"shape":"Description",
@ -3215,5 +3215,5 @@
"VpcId":{"type":"string"},
"ZoneName":{"type":"string"}
},
"documentation":"<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers.</p> <p>An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC).</p> <p>A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. For more information, see the <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>This reference covers the 2015-12-01 API, which supports Application Load Balancers and Network Load Balancers. The 2012-06-01 API supports Classic Load Balancers.</p> <p>To get started, complete the following tasks:</p> <ol> <li> <p>Create a load balancer using <a>CreateLoadBalancer</a>.</p> </li> <li> <p>Create a target group using <a>CreateTargetGroup</a>.</p> </li> <li> <p>Register targets for the target group using <a>RegisterTargets</a>.</p> </li> <li> <p>Create one or more listeners for your load balancer using <a>CreateListener</a>.</p> </li> </ol> <p>To delete a load balancer and its related resources, complete the following tasks:</p> <ol> <li> <p>Delete the load balancer using <a>DeleteLoadBalancer</a>.</p> </li> <li> <p>Delete the target group using <a>DeleteTargetGroup</a>.</p> </li> </ol> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>"
"documentation":"<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. This reference covers Application Load Balancers and Network Load Balancers.</p> <p>An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>"
}

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

@ -165,6 +165,20 @@
],
"documentation":"<p>Provides more detail about the cluster step.</p>"
},
"GetBlockPublicAccessConfiguration":{
"name":"GetBlockPublicAccessConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetBlockPublicAccessConfigurationInput"},
"output":{"shape":"GetBlockPublicAccessConfigurationOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html\">Configure Block Public Access for Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p>"
},
"ListBootstrapActions":{
"name":"ListBootstrapActions",
"http":{
@ -298,6 +312,20 @@
"output":{"shape":"PutAutoScalingPolicyOutput"},
"documentation":"<p>Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.</p>"
},
"PutBlockPublicAccessConfiguration":{
"name":"PutBlockPublicAccessConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutBlockPublicAccessConfigurationInput"},
"output":{"shape":"PutBlockPublicAccessConfigurationOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see <a href=\"https://docs.aws.amazon.com/emr/latest/ManagementGuide/configure-block-public-access.html\">Configure Block Public Access for Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p>"
},
"RemoveAutoScalingPolicy":{
"name":"RemoveAutoScalingPolicy",
"http":{
@ -357,7 +385,7 @@
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<p>Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the <code>VisibleToAllUsers</code> parameter of <a>RunJobFlow</a>. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster.</p>"
"documentation":"<p> <i>This member will be deprecated.</i> </p> <p>Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the <code>VisibleToAllUsers</code> parameter of <a>RunJobFlow</a>. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster.</p>"
},
"TerminateJobFlows":{
"name":"TerminateJobFlows",
@ -530,6 +558,11 @@
"type":"list",
"member":{"shape":"Application"}
},
"ArnType":{
"type":"string",
"max":2048,
"min":20
},
"AutoScalingPolicy":{
"type":"structure",
"required":[
@ -613,6 +646,39 @@
},
"documentation":"<p>The status of an automatic scaling policy. </p>"
},
"BlockPublicAccessConfiguration":{
"type":"structure",
"required":["BlockPublicSecurityGroupRules"],
"members":{
"BlockPublicSecurityGroupRules":{
"shape":"Boolean",
"documentation":"<p>Indicates whether EMR block public access is enabled (<code>true</code>) or disabled (<code>false</code>). By default, the value is <code>false</code> for accounts that have created EMR clusters before July 2019. For accounts created after this, the default is <code>true</code>.</p>"
},
"PermittedPublicSecurityGroupRuleRanges":{
"shape":"PortRanges",
"documentation":"<p>Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for <code>PermittedPublicSecurityGroupRuleRanges</code>, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.</p> <p>By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in the list of <code>PermittedPublicSecurityGroupRuleRanges</code>.</p>"
}
},
"documentation":"<p>A configuration for Amazon EMR block public access. When <code>BlockPublicSecurityGroupRules</code> is set to <code>true</code>, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using <code>PermittedPublicSecurityGroupRuleRanges</code>.</p>"
},
"BlockPublicAccessConfigurationMetadata":{
"type":"structure",
"required":[
"CreationDateTime",
"CreatedByArn"
],
"members":{
"CreationDateTime":{
"shape":"Date",
"documentation":"<p>The date and time that the configuration was created.</p>"
},
"CreatedByArn":{
"shape":"ArnType",
"documentation":"<p>The Amazon Resource Name that created or last modified the configuration.</p>"
}
},
"documentation":"<p>Properties that describe the AWS principal that created the <code>BlockPublicAccessConfiguration</code> using the <code>PutBlockPublicAccessConfiguration</code> action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.</p>"
},
"Boolean":{"type":"boolean"},
"BooleanObject":{"type":"boolean"},
"BootstrapActionConfig":{
@ -789,7 +855,7 @@
},
"ReleaseLabel":{
"shape":"String",
"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=\"https://docs.aws.amazon.com/emr/latest/ReleaseGuide/\">https://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>"
"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 such as <code>emr-5.14.0</code>. For more information about Amazon EMR release versions and included application versions and features, see <a href=\"https://docs.aws.amazon.com/emr/latest/ReleaseGuide/\">https://docs.aws.amazon.com/emr/latest/ReleaseGuide/</a>. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use <code>AmiVersion</code>.</p>"
},
"AutoTerminate":{
"shape":"Boolean",
@ -801,7 +867,7 @@
},
"VisibleToAllUsers":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to <code>true</code>, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is <code>false</code>, only the IAM user that created the cluster can view and manage it. This value can be changed using the <a>SetVisibleToAllUsers</a> action.</p>"
"documentation":"<p> <i>This member will be deprecated.</i> </p> <p>Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to <code>true</code>, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is <code>false</code>, only the IAM user that created the cluster can view and manage it. This value can be changed using the <a>SetVisibleToAllUsers</a> action.</p>"
},
"Applications":{
"shape":"ApplicationList",
@ -1261,11 +1327,11 @@
},
"Ec2SubnetId":{
"shape":"String",
"documentation":"<p>To launch the cluster in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster is launched in the normal AWS cloud, outside of a VPC.</p> <p>Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a cluster launched in a VPC.</p>"
"documentation":"<p>Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.</p>"
},
"RequestedEc2SubnetIds":{
"shape":"XmlStringMaxLen256List",
"documentation":"<p>Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of <code>RequestedEc2SubnetIds</code>, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses <code>RequestedEc2AvailabilityZones</code> instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. <code>RequestedEc2SubnetIDs</code> and <code>RequestedEc2AvailabilityZones</code> cannot be specified together.</p>"
"documentation":"<p>Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of <code>RequestedEc2SubnetIds</code>, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses <code>RequestedEc2AvailabilityZones</code> instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. <code>RequestedEc2SubnetIDs</code> and <code>RequestedEc2AvailabilityZones</code> cannot be specified together.</p>"
},
"Ec2AvailabilityZone":{
"shape":"String",
@ -1326,6 +1392,28 @@
},
"documentation":"<p>The details of the step failure. The service attempts to detect the root cause for many common failures.</p>"
},
"GetBlockPublicAccessConfigurationInput":{
"type":"structure",
"members":{
}
},
"GetBlockPublicAccessConfigurationOutput":{
"type":"structure",
"required":[
"BlockPublicAccessConfiguration",
"BlockPublicAccessConfigurationMetadata"
],
"members":{
"BlockPublicAccessConfiguration":{
"shape":"BlockPublicAccessConfiguration",
"documentation":"<p>A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using <code>PermittedPublicSecurityGroupRuleRanges</code> in the <code>BlockPublicAccessConfiguration</code>. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.</p>"
},
"BlockPublicAccessConfigurationMetadata":{
"shape":"BlockPublicAccessConfigurationMetadata",
"documentation":"<p>Properties that describe the AWS principal that created the <code>BlockPublicAccessConfiguration</code> using the <code>PutBlockPublicAccessConfiguration</code> action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.</p>"
}
}
},
"HadoopJarStepConfig":{
"type":"structure",
"required":["Jar"],
@ -2220,7 +2308,7 @@
},
"VisibleToAllUsers":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to <code>true</code>, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to <code>false</code>, only the IAM user that created the cluster can view and manage it. This value can be changed using the <a>SetVisibleToAllUsers</a> action.</p>"
"documentation":"<p> <i>This member will be deprecated.</i> </p> <p>Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to <code>true</code>, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to <code>false</code>, only the IAM user that created the cluster can view and manage it. This value can be changed using the <a>SetVisibleToAllUsers</a> action.</p>"
},
"JobFlowRole":{
"shape":"XmlString",
@ -2342,7 +2430,7 @@
},
"Ec2SubnetId":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, the cluster launches in the normal Amazon Web Services cloud, outside of an Amazon VPC, if the account launching the cluster supports EC2 Classic networks in the region where the cluster launches.</p> <p>Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for clusters launched in an Amazon VPC.</p>"
"documentation":"<p>Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.</p>"
},
"Ec2SubnetIds":{
"shape":"XmlStringMaxLen256List",
@ -2791,6 +2879,30 @@
},
"documentation":"<p>The Amazon EC2 Availability Zone configuration of the cluster (job flow).</p>"
},
"Port":{
"type":"integer",
"max":65535,
"min":0
},
"PortRange":{
"type":"structure",
"required":["MinRange"],
"members":{
"MinRange":{
"shape":"Port",
"documentation":"<p>The smallest port number in a specified range of port numbers.</p>"
},
"MaxRange":{
"shape":"Port",
"documentation":"<p>The smallest port number in a specified range of port numbers.</p>"
}
},
"documentation":"<p>A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value for <code>MinRange</code> and <code>MaxRange</code>.</p>"
},
"PortRanges":{
"type":"list",
"member":{"shape":"PortRange"}
},
"PutAutoScalingPolicyInput":{
"type":"structure",
"required":[
@ -2830,6 +2942,21 @@
}
}
},
"PutBlockPublicAccessConfigurationInput":{
"type":"structure",
"required":["BlockPublicAccessConfiguration"],
"members":{
"BlockPublicAccessConfiguration":{
"shape":"BlockPublicAccessConfiguration",
"documentation":"<p>A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using <code>PermittedPublicSecurityGroupRuleRanges</code> in the <code>BlockPublicAccessConfiguration</code>. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating <code>BlockPublicSecurityGroupRules</code> to remove the exception.</p>"
}
}
},
"PutBlockPublicAccessConfigurationOutput":{
"type":"structure",
"members":{
}
},
"RemoveAutoScalingPolicyInput":{
"type":"structure",
"required":[
@ -2909,7 +3036,7 @@
},
"ReleaseLabel":{
"shape":"XmlStringMaxLen256",
"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=\"https://docs.aws.amazon.com/emr/latest/ReleaseGuide/\">https://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>"
"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 such as <code>emr-5.14.0</code>. For more information about Amazon EMR release versions and included application versions and features, see <a href=\"https://docs.aws.amazon.com/emr/latest/ReleaseGuide/\">https://docs.aws.amazon.com/emr/latest/ReleaseGuide/</a>. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use <code>AmiVersion</code>.</p>"
},
"Instances":{
"shape":"JobFlowInstancesConfig",
@ -2941,7 +3068,7 @@
},
"VisibleToAllUsers":{
"shape":"Boolean",
"documentation":"<p>Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to <code>true</code>, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to <code>false</code>, only the IAM user that created the cluster can view and manage it.</p>"
"documentation":"<p> <i>This member will be deprecated.</i> </p> <p>Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to <code>true</code>, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to <code>false</code>, only the IAM user that created the cluster can view and manage it.</p>"
},
"JobFlowRole":{
"shape":"XmlString",
@ -3146,10 +3273,10 @@
},
"VisibleToAllUsers":{
"shape":"Boolean",
"documentation":"<p>Whether the specified clusters are visible to all IAM users of the AWS account associated with the cluster. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the clusters. If it is set to False, only the IAM user that created a cluster can view and manage it.</p>"
"documentation":"<p> <i>This member will be deprecated.</i> </p> <p>Whether the specified clusters are visible to all IAM users of the AWS account associated with the cluster. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the clusters. If it is set to False, only the IAM user that created a cluster can view and manage it.</p>"
}
},
"documentation":"<p>The input to the SetVisibleToAllUsers action.</p>"
"documentation":"<p> <i>This member will be deprecated.</i> </p> <p>The input to the SetVisibleToAllUsers action.</p>"
},
"ShrinkPolicy":{
"type":"structure",

642
botocore/data/endpoints.json
View file

@ -233,6 +233,7 @@
"ap-northeast-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-2" : { }
@ -251,6 +252,7 @@
},
"api.sagemaker" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -258,8 +260,11 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-1-fips" : {
"credentialScope" : {
@ -393,6 +398,7 @@
},
"athena" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -798,6 +804,7 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -920,6 +927,15 @@
"us-west-2" : { }
}
},
"connect" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"us-east-1" : { },
"us-west-2" : { }
}
},
"cur" : {
"endpoints" : {
"us-east-1" : { }
@ -933,6 +949,7 @@
"protocols" : [ "https" ]
},
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -944,6 +961,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1004,6 +1022,7 @@
},
"hostname" : "datasync-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -1032,6 +1051,7 @@
},
"directconnect" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -1471,6 +1491,7 @@
},
"firehose" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -1513,6 +1534,7 @@
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
@ -1578,6 +1600,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1627,11 +1650,36 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-1-fips" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "guardduty-fips.us-east-1.amazonaws.com"
},
"us-east-2" : { },
"us-east-2-fips" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "guardduty-fips.us-east-2.amazonaws.com"
},
"us-west-1" : { },
"us-west-2" : { }
"us-west-1-fips" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "guardduty-fips.us-west-1.amazonaws.com"
},
"us-west-2" : { },
"us-west-2-fips" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "guardduty-fips.us-west-2.amazonaws.com"
}
},
"isRegionalized" : true
},
@ -1689,6 +1737,7 @@
}
},
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -1700,6 +1749,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1831,11 +1881,14 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
@ -1918,6 +1971,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -1983,6 +2037,7 @@
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
@ -2036,6 +2091,7 @@
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -2322,6 +2378,15 @@
"us-west-2" : { }
}
},
"qldb" : {
"endpoints" : {
"ap-northeast-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
"ram" : {
"endpoints" : {
"ap-northeast-1" : { },
@ -2417,6 +2482,30 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "resource-groups-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "resource-groups-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "resource-groups-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "resource-groups-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -2488,6 +2577,7 @@
},
"runtime.sagemaker" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -2495,8 +2585,11 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-1-fips" : {
"credentialScope" : {
@ -2918,6 +3011,7 @@
},
"servicediscovery" : {
"endpoints" : {
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -2925,9 +3019,11 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -2935,6 +3031,15 @@
"us-west-2" : { }
}
},
"session.qldb" : {
"endpoints" : {
"ap-northeast-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
"shield" : {
"defaults" : {
"protocols" : [ "https" ],
@ -2959,6 +3064,7 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -3325,9 +3431,11 @@
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-north-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
@ -4319,6 +4427,22 @@
"us-gov-west-1" : { }
}
},
"neptune" : {
"endpoints" : {
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "rds.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "rds.us-gov-west-1.amazonaws.com"
}
}
},
"organizations" : {
"endpoints" : {
"aws-us-gov-global" : {
@ -4338,6 +4462,7 @@
},
"ram" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
}
},
@ -4456,6 +4581,17 @@
}
}
},
"servicecatalog" : {
"endpoints" : {
"us-gov-west-1" : { },
"us-gov-west-1-fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "servicecatalog-fips.us-gov-west-1.amazonaws.com"
}
}
},
"sms" : {
"endpoints" : {
"us-gov-east-1" : { },
@ -4568,6 +4704,510 @@
}
}
}
}, {
"defaults" : {
"hostname" : "{service}.{region}.{dnsSuffix}",
"protocols" : [ "https" ],
"signatureVersions" : [ "v4" ]
},
"dnsSuffix" : "c2s.ic.gov",
"partition" : "aws-iso",
"partitionName" : "AWS ISO (US)",
"regionRegex" : "^us\\-iso\\-\\w+\\-\\d+$",
"regions" : {
"us-iso-east-1" : {
"description" : "US ISO East"
}
},
"services" : {
"api.ecr" : {
"endpoints" : {
"us-iso-east-1" : {
"credentialScope" : {
"region" : "us-iso-east-1"
},
"hostname" : "api.ecr.us-iso-east-1.c2s.ic.gov"
}
}
},
"application-autoscaling" : {
"defaults" : {
"credentialScope" : {
"service" : "application-autoscaling"
},
"hostname" : "autoscaling.{region}.amazonaws.com",
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-iso-east-1" : { }
}
},
"autoscaling" : {
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ]
}
}
},
"cloudformation" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"cloudtrail" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"codedeploy" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"config" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"datapipeline" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"directconnect" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"dms" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"ds" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"dynamodb" : {
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ]
}
}
},
"ec2" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"ecs" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"elasticache" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"elasticloadbalancing" : {
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ]
}
}
},
"elasticmapreduce" : {
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "https" ]
}
}
},
"events" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"glacier" : {
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ]
}
}
},
"health" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"iam" : {
"endpoints" : {
"aws-iso-global" : {
"credentialScope" : {
"region" : "us-iso-east-1"
},
"hostname" : "iam.us-iso-east-1.c2s.ic.gov"
}
},
"isRegionalized" : false,
"partitionEndpoint" : "aws-iso-global"
},
"kinesis" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"kms" : {
"endpoints" : {
"ProdFips" : {
"credentialScope" : {
"region" : "us-iso-east-1"
},
"hostname" : "kms-fips.us-iso-east-1.c2s.ic.gov"
},
"us-iso-east-1" : { }
}
},
"lambda" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"logs" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"monitoring" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"rds" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"redshift" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"route53" : {
"endpoints" : {
"aws-iso-global" : {
"credentialScope" : {
"region" : "us-iso-east-1"
},
"hostname" : "route53.c2s.ic.gov"
}
},
"isRegionalized" : false,
"partitionEndpoint" : "aws-iso-global"
},
"s3" : {
"defaults" : {
"signatureVersions" : [ "s3v4" ]
},
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ],
"signatureVersions" : [ "s3v4" ]
}
}
},
"snowball" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"sns" : {
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ]
}
}
},
"sqs" : {
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ]
}
}
},
"states" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"streams.dynamodb" : {
"defaults" : {
"credentialScope" : {
"service" : "dynamodb"
},
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-iso-east-1" : {
"protocols" : [ "http", "https" ]
}
}
},
"sts" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"support" : {
"endpoints" : {
"aws-iso-global" : {
"credentialScope" : {
"region" : "us-iso-east-1"
},
"hostname" : "support.us-iso-east-1.c2s.ic.gov"
}
},
"partitionEndpoint" : "aws-iso-global"
},
"swf" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"workspaces" : {
"endpoints" : {
"us-iso-east-1" : { }
}
}
}
}, {
"defaults" : {
"hostname" : "{service}.{region}.{dnsSuffix}",
"protocols" : [ "https" ],
"signatureVersions" : [ "v4" ]
},
"dnsSuffix" : "sc2s.sgov.gov",
"partition" : "aws-iso-b",
"partitionName" : "AWS ISOB (US)",
"regionRegex" : "^us\\-isob\\-\\w+\\-\\d+$",
"regions" : {
"us-isob-east-1" : {
"description" : "US ISOB East (Ohio)"
}
},
"services" : {
"application-autoscaling" : {
"defaults" : {
"credentialScope" : {
"service" : "application-autoscaling"
},
"hostname" : "autoscaling.{region}.amazonaws.com",
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"autoscaling" : {
"defaults" : {
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"cloudformation" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"cloudtrail" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"config" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"directconnect" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"dms" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"dynamodb" : {
"defaults" : {
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"ec2" : {
"defaults" : {
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"elasticache" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"elasticloadbalancing" : {
"endpoints" : {
"us-isob-east-1" : {
"protocols" : [ "https" ]
}
}
},
"elasticmapreduce" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"events" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"glacier" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"health" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"iam" : {
"endpoints" : {
"aws-iso-b-global" : {
"credentialScope" : {
"region" : "us-isob-east-1"
},
"hostname" : "iam.us-isob-east-1.sc2s.sgov.gov"
}
},
"isRegionalized" : false,
"partitionEndpoint" : "aws-iso-b-global"
},
"kinesis" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"kms" : {
"endpoints" : {
"ProdFips" : {
"credentialScope" : {
"region" : "us-isob-east-1"
},
"hostname" : "kms-fips.us-isob-east-1.sc2s.sgov.gov"
},
"us-isob-east-1" : { }
}
},
"logs" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"monitoring" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"rds" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"redshift" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"s3" : {
"defaults" : {
"protocols" : [ "http", "https" ],
"signatureVersions" : [ "s3v4" ]
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"snowball" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"sns" : {
"defaults" : {
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"sqs" : {
"defaults" : {
"protocols" : [ "http", "https" ],
"sslCommonName" : "{region}.queue.{dnsSuffix}"
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"states" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"streams.dynamodb" : {
"defaults" : {
"credentialScope" : {
"service" : "dynamodb"
},
"protocols" : [ "http", "https" ]
},
"endpoints" : {
"us-isob-east-1" : { }
}
},
"sts" : {
"endpoints" : {
"us-isob-east-1" : { }
}
},
"support" : {
"endpoints" : {
"aws-iso-b-global" : {
"credentialScope" : {
"region" : "us-isob-east-1"
},
"hostname" : "support.us-isob-east-1.sc2s.sgov.gov"
}
},
"partitionEndpoint" : "aws-iso-b-global"
},
"swf" : {
"endpoints" : {
"us-isob-east-1" : { }
}
}
}
} ],
"version" : 3
}

40
botocore/data/forecast/2018-06-26/paginators-1.json Normal file
View file

@ -0,0 +1,40 @@
{
"pagination": {
"ListDatasetGroups": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "DatasetGroups"
},
"ListDatasetImportJobs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "DatasetImportJobs"
},
"ListDatasets": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Datasets"
},
"ListForecastExportJobs": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ForecastExportJobs"
},
"ListForecasts": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Forecasts"
},
"ListPredictors": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Predictors"
}
}
}

2149
botocore/data/forecast/2018-06-26/service-2.json Normal file
View file

@ -0,0 +1,2149 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-06-26",
"endpointPrefix":"forecast",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Forecast Service",
"serviceId":"forecast",
"signatureVersion":"v4",
"signingName":"forecast",
"targetPrefix":"AmazonForecast",
"uid":"forecast-2018-06-26"
},
"operations":{
"CreateDataset":{
"name":"CreateDataset",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDatasetRequest"},
"output":{"shape":"CreateDatasetResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:</p> <ul> <li> <p> <i> <code>DataFrequency</code> </i> - How frequently your historical time-series data is collected. Amazon Forecast uses this information when training the model and generating a forecast.</p> </li> <li> <p> <i> <code>Domain</code> </i> and <i> <code>DatasetType</code> </i> - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.</p> </li> <li> <p> <i> <code>Schema</code> </i> - A schema specifies the fields of the dataset, including the field name and data type.</p> </li> </ul> <p>After creating a dataset, you import your training data into the dataset and add the dataset to a dataset group. You then use the dataset group to create a predictor. For more information, see <a>howitworks-datasets-groups</a>.</p> <p>To get a list of all your datasets, use the <a>ListDatasets</a> operation.</p> <note> <p>The <code>Status</code> of a dataset must be <code>ACTIVE</code> before you can import training data. Use the <a>DescribeDataset</a> operation to get the status.</p> </note>"
},
"CreateDatasetGroup":{
"name":"CreateDatasetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDatasetGroupRequest"},
"output":{"shape":"CreateDatasetGroupResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates an Amazon Forecast dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or you can add datasets later with the <a>UpdateDatasetGroup</a> operation.</p> <p>After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see <a>howitworks-datasets-groups</a>.</p> <p>To get a list of all your datasets groups, use the <a>ListDatasetGroups</a> operation.</p> <note> <p>The <code>Status</code> of a dataset group must be <code>ACTIVE</code> before you can create a predictor using the dataset group. Use the <a>DescribeDatasetGroup</a> operation to get the status.</p> </note>"
},
"CreateDatasetImportJob":{
"name":"CreateDatasetImportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDatasetImportJobRequest"},
"output":{"shape":"CreateDatasetImportJobResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.</p> <p>You must specify a <a>DataSource</a> object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see <a>aws-forecast-iam-roles</a>.</p> <p>Two properties of the training data are optionally specified:</p> <ul> <li> <p>The delimiter that separates the data fields.</p> <p>The default delimiter is a comma (,), which is the only supported delimiter in this release.</p> </li> <li> <p>The format of timestamps.</p> <p>If the format is not specified, Amazon Forecast expects the format to be \"yyyy-MM-dd HH:mm:ss\".</p> </li> </ul> <p>When Amazon Forecast uploads your training data, it verifies that the data was collected at the <code>DataFrequency</code> specified when the target dataset was created. For more information, see <a>CreateDataset</a> and <a>howitworks-datasets-groups</a>. Amazon Forecast also verifies the delimiter and timestamp format.</p> <p>You can use the <a>ListDatasetImportJobs</a> operation to get a list of all your dataset import jobs, filtered by specified criteria.</p> <p>To get a list of all your dataset import jobs, filtered by the specified criteria, use the <a>ListDatasetGroups</a> operation.</p>"
},
"CreateForecast":{
"name":"CreateForecast",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateForecastRequest"},
"output":{"shape":"CreateForecastResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a forecast for each item in the <code>TARGET_TIME_SERIES</code> dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3), use the <a>CreateForecastExportJob</a> operation.</p> <p>The range of the forecast is determined by the <code>ForecastHorizon</code>, specified in the <a>CreatePredictor</a> request, multiplied by the <code>DataFrequency</code>, specified in the <a>CreateDataset</a> request. When you query a forecast, you can request a specific date range within the complete forecast.</p> <p>To get a list of all your forecasts, use the <a>ListForecasts</a> operation.</p> <note> <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.</p> </note> <p>For more information, see <a>howitworks-forecast</a>.</p> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast. Use the <a>DescribeForecast</a> operation to get the status.</p> </note>"
},
"CreateForecastExportJob":{
"name":"CreateForecastExportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateForecastExportJobRequest"},
"output":{"shape":"CreateForecastExportJobResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Exports a forecast created by the <a>CreateForecast</a> operation to your Amazon Simple Storage Service (Amazon S3) bucket.</p> <p>You must specify a <a>DataDestination</a> object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p> <p>For more information, see <a>howitworks-forecast</a>.</p> <p>To get a list of all your forecast export jobs, use the <a>ListForecastExportJobs</a> operation.</p> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your Amazon S3 bucket. Use the <a>DescribeForecastExportJob</a> operation to get the status.</p> </note>"
},
"CreatePredictor":{
"name":"CreatePredictor",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreatePredictorRequest"},
"output":{"shape":"CreatePredictorResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates an Amazon Forecast predictor.</p> <p>In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.</p> <p>Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the <a>CreateForecast</a> operation.</p> <p>After training a model, the <code>CreatePredictor</code> operation also evaluates it. To see the evaluation metrics, use the <a>GetAccuracyMetrics</a> operation. Always review the evaluation metrics before deciding to use the predictor to generate a forecast.</p> <p>Optionally, you can specify a featurization configuration to fill and aggragate the data fields in the <code>TARGET_TIME_SERIES</code> dataset to improve model training. For more information, see <a>FeaturizationConfig</a>.</p> <p> <b>AutoML</b> </p> <p>If you set <code>PerformAutoML</code> to <code>true</code>, Amazon Forecast evaluates each algorithm and chooses the one that minimizes the <code>objective function</code>. The <code>objective function</code> is defined as the mean of the weighted p10, p50, and p90 quantile losses. For more information, see <a>EvaluationResult</a>.</p> <p>When AutoML is enabled, the following properties are disallowed:</p> <ul> <li> <p> <code>AlgorithmArn</code> </p> </li> <li> <p> <code>HPOConfig</code> </p> </li> <li> <p> <code>PerformHPO</code> </p> </li> <li> <p> <code>TrainingParameters</code> </p> </li> </ul> <p>To get a list of all your predictors, use the <a>ListPredictors</a> operation.</p> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code>, signifying that training has completed, before you can use the predictor to create a forecast. Use the <a>DescribePredictor</a> operation to get the status.</p> </note>"
},
"DeleteDataset":{
"name":"DeleteDataset",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDatasetRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes an Amazon Forecast dataset created using the <a>CreateDataset</a> operation. To be deleted, the dataset must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeDataset</a> operation to get the status.</p>",
"idempotent":true
},
"DeleteDatasetGroup":{
"name":"DeleteDatasetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDatasetGroupRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes a dataset group created using the <a>CreateDatasetGroup</a> operation. To be deleted, the dataset group must have a status of <code>ACTIVE</code>, <code>CREATE_FAILED</code>, or <code>UPDATE_FAILED</code>. Use the <a>DescribeDatasetGroup</a> operation to get the status.</p> <p>The operation deletes only the dataset group, not the datasets in the group.</p>",
"idempotent":true
},
"DeleteDatasetImportJob":{
"name":"DeleteDatasetImportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDatasetImportJobRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes a dataset import job created using the <a>CreateDatasetImportJob</a> operation. To be deleted, the import job must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeDatasetImportJob</a> operation to get the status.</p>",
"idempotent":true
},
"DeleteForecast":{
"name":"DeleteForecast",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteForecastRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes a forecast created using the <a>CreateForecast</a> operation. To be deleted, the forecast must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeForecast</a> operation to get the status.</p> <p>You can't delete a forecast while it is being exported.</p>",
"idempotent":true
},
"DeleteForecastExportJob":{
"name":"DeleteForecastExportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteForecastExportJobRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes a forecast export job created using the <a>CreateForecastExportJob</a> operation. To be deleted, the export job must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribeForecastExportJob</a> operation to get the status.</p>",
"idempotent":true
},
"DeletePredictor":{
"name":"DeletePredictor",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeletePredictorRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Deletes a predictor created using the <a>CreatePredictor</a> operation. To be deleted, the predictor must have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. Use the <a>DescribePredictor</a> operation to get the status.</p> <p>Any forecasts generated by the predictor will no longer be available.</p>",
"idempotent":true
},
"DescribeDataset":{
"name":"DescribeDataset",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDatasetRequest"},
"output":{"shape":"DescribeDatasetResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes an Amazon Forecast dataset created using the <a>CreateDataset</a> operation.</p> <p>In addition to listing the properties provided by the user in the <code>CreateDataset</code> request, this operation includes the following properties:</p> <ul> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Status</code> </p> </li> </ul>",
"idempotent":true
},
"DescribeDatasetGroup":{
"name":"DescribeDatasetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDatasetGroupRequest"},
"output":{"shape":"DescribeDatasetGroupResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes a dataset group created using the <a>CreateDatasetGroup</a> operation.</p> <p>In addition to listing the properties provided by the user in the <code>CreateDatasetGroup</code> request, this operation includes the following properties:</p> <ul> <li> <p> <code>DatasetArns</code> - The datasets belonging to the group.</p> </li> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Status</code> </p> </li> </ul>",
"idempotent":true
},
"DescribeDatasetImportJob":{
"name":"DescribeDatasetImportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDatasetImportJobRequest"},
"output":{"shape":"DescribeDatasetImportJobResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes a dataset import job created using the <a>CreateDatasetImportJob</a> operation.</p> <p>In addition to listing the properties provided by the user in the <code>CreateDatasetImportJob</code> request, this operation includes the following properties:</p> <ul> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>DataSize</code> </p> </li> <li> <p> <code>FieldStatistics</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> </ul>",
"idempotent":true
},
"DescribeForecast":{
"name":"DescribeForecast",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeForecastRequest"},
"output":{"shape":"DescribeForecastResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes a forecast created using the <a>CreateForecast</a> operation.</p> <p>In addition to listing the properties provided by the user in the <code>CreateForecast</code> request, this operation includes the following properties:</p> <ul> <li> <p> <code>DatasetGroupArn</code> - The dataset group that provided the training data.</p> </li> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> </ul>",
"idempotent":true
},
"DescribeForecastExportJob":{
"name":"DescribeForecastExportJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeForecastExportJobRequest"},
"output":{"shape":"DescribeForecastExportJobResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes a forecast export job created using the <a>CreateForecastExportJob</a> operation.</p> <p>In addition to listing the properties provided by the user in the <code>CreateForecastExportJob</code> request, this operation includes the following properties:</p> <ul> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> </ul>",
"idempotent":true
},
"DescribePredictor":{
"name":"DescribePredictor",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribePredictorRequest"},
"output":{"shape":"DescribePredictorResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes a predictor created using the <a>CreatePredictor</a> operation.</p> <p>In addition to listing the properties provided by the user in the <code>CreatePredictor</code> request, this operation includes the following properties:</p> <ul> <li> <p> <code>DatasetImportJobArns</code> - The dataset import jobs used to import training data.</p> </li> <li> <p> <code>AutoMLAlgorithmArns</code> - If AutoML is performed, the algorithms evaluated.</p> </li> <li> <p> <code>CreationTime</code> </p> </li> <li> <p> <code>LastModificationTime</code> </p> </li> <li> <p> <code>Status</code> </p> </li> <li> <p> <code>Message</code> - If an error occurred, information about the error.</p> </li> </ul>",
"idempotent":true
},
"GetAccuracyMetrics":{
"name":"GetAccuracyMetrics",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAccuracyMetricsRequest"},
"output":{"shape":"GetAccuracyMetricsResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Provides metrics on the accuracy of the models that were trained by the <a>CreatePredictor</a> operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast.</p> <p>Metrics are generated for each backtest window evaluated. For more information, see <a>EvaluationParameters</a>.</p> <p>The parameters of the <code>filling</code> method determine which items contribute to the metrics. If <code>zero</code> is specified, all items contribute. If <code>nan</code> is specified, only those items that have complete data in the range being evaluated contribute. For more information, see <a>FeaturizationMethod</a>.</p> <p>For an example of how to train a model and review metrics, see <a>getting-started</a>.</p>",
"idempotent":true
},
"ListDatasetGroups":{
"name":"ListDatasetGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDatasetGroupsRequest"},
"output":{"shape":"ListDatasetGroupsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns a list of dataset groups created using the <a>CreateDatasetGroup</a> operation. For each dataset group, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeDatasetGroup</a> operation.</p>",
"idempotent":true
},
"ListDatasetImportJobs":{
"name":"ListDatasetImportJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDatasetImportJobsRequest"},
"output":{"shape":"ListDatasetImportJobsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns a list of dataset import jobs created using the <a>CreateDatasetImportJob</a> operation. For each import job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeDatasetImportJob</a> operation. You can filter the list by providing an array of <a>Filter</a> objects.</p>",
"idempotent":true
},
"ListDatasets":{
"name":"ListDatasets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDatasetsRequest"},
"output":{"shape":"ListDatasetsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns a list of datasets created using the <a>CreateDataset</a> operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeDataset</a> operation.</p>",
"idempotent":true
},
"ListForecastExportJobs":{
"name":"ListForecastExportJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListForecastExportJobsRequest"},
"output":{"shape":"ListForecastExportJobsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns a list of forecast export jobs created using the <a>CreateForecastExportJob</a> operation. For each forecast export job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeForecastExportJob</a> operation. The list can be filtered using an array of <a>Filter</a> objects.</p>",
"idempotent":true
},
"ListForecasts":{
"name":"ListForecasts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListForecastsRequest"},
"output":{"shape":"ListForecastsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns a list of forecasts created using the <a>CreateForecast</a> operation. For each forecast, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribeForecast</a> operation. The list can be filtered using an array of <a>Filter</a> objects.</p>",
"idempotent":true
},
"ListPredictors":{
"name":"ListPredictors",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListPredictorsRequest"},
"output":{"shape":"ListPredictorsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns a list of predictors created using the <a>CreatePredictor</a> operation. For each predictor, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the <a>DescribePredictor</a> operation. The list can be filtered using an array of <a>Filter</a> objects.</p>",
"idempotent":true
},
"UpdateDatasetGroup":{
"name":"UpdateDatasetGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDatasetGroupRequest"},
"output":{"shape":"UpdateDatasetGroupResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Replaces any existing datasets in the dataset group with the specified datasets.</p> <note> <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before creating a predictor using the dataset group. Use the <a>DescribeDatasetGroup</a> operation to get the status.</p> </note>",
"idempotent":true
}
},
"shapes":{
"Arn":{
"type":"string",
"max":256,
"pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$"
},
"ArnList":{
"type":"list",
"member":{"shape":"Arn"}
},
"AttributeType":{
"type":"string",
"enum":[
"string",
"integer",
"float",
"timestamp"
]
},
"Boolean":{"type":"boolean"},
"CategoricalParameterRange":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the categorical hyperparameter to tune.</p>"
},
"Values":{
"shape":"Values",
"documentation":"<p>A list of the tunable categories for the hyperparameter.</p>"
}
},
"documentation":"<p>Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the <a>ParameterRanges</a> object.</p>"
},
"CategoricalParameterRanges":{
"type":"list",
"member":{"shape":"CategoricalParameterRange"},
"max":20,
"min":1
},
"ContinuousParameterRange":{
"type":"structure",
"required":[
"Name",
"MaxValue",
"MinValue"
],
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the hyperparameter to tune.</p>"
},
"MaxValue":{
"shape":"Double",
"documentation":"<p>The maximum tunable value of the hyperparameter.</p>"
},
"MinValue":{
"shape":"Double",
"documentation":"<p>The minimum tunable value of the hyperparameter.</p>"
},
"ScalingType":{
"shape":"ScalingType",
"documentation":"<p>The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type\">Hyperparameter Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.</p> </dd> <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling works only for ranges that have only values greater than 0.</p> </dd> <dt>ReverseLogarithmic</dt> <dd> <p>Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.</p> <p>Reverse logarithmic scaling works only for ranges that are entirely within the range 0 &lt;= x &lt; 1.0.</p> </dd> </dl>"
}
},
"documentation":"<p>Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the <a>ParameterRanges</a> object.</p>"
},
"ContinuousParameterRanges":{
"type":"list",
"member":{"shape":"ContinuousParameterRange"},
"max":20,
"min":1
},
"CreateDatasetGroupRequest":{
"type":"structure",
"required":[
"DatasetGroupName",
"Domain"
],
"members":{
"DatasetGroupName":{
"shape":"Name",
"documentation":"<p>A name for the dataset group.</p>"
},
"Domain":{
"shape":"Domain",
"documentation":"<p>The domain associated with the dataset group. The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>, and <code>demand</code> fields to be present in your data. For more information, see <a>howitworks-datasets-groups</a>.</p>"
},
"DatasetArns":{
"shape":"ArnList",
"documentation":"<p>An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.</p>"
}
}
},
"CreateDatasetGroupResponse":{
"type":"structure",
"members":{
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group.</p>"
}
}
},
"CreateDatasetImportJobRequest":{
"type":"structure",
"required":[
"DatasetImportJobName",
"DatasetArn",
"DataSource"
],
"members":{
"DatasetImportJobName":{
"shape":"Name",
"documentation":"<p>The name for the dataset import job. It is recommended to include the current timestamp in the name to guard against getting a <code>ResourceAlreadyExistsException</code> exception, for example, <code>20190721DatasetImport</code>.</p>"
},
"DatasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.</p>"
},
"DataSource":{
"shape":"DataSource",
"documentation":"<p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.</p>"
},
"TimestampFormat":{
"shape":"TimestampFormat",
"documentation":"<p>The format of timestamps in the dataset. Two formats are supported, dependent on the <code>DataFrequency</code> specified when the dataset was created.</p> <ul> <li> <p>\"yyyy-MM-dd\"</p> <p>For data frequencies: Y, M, W, and D</p> </li> <li> <p>\"yyyy-MM-dd HH:mm:ss\"</p> <p>For data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D</p> </li> </ul>"
}
}
},
"CreateDatasetImportJobResponse":{
"type":"structure",
"members":{
"DatasetImportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset import job.</p>"
}
}
},
"CreateDatasetRequest":{
"type":"structure",
"required":[
"DatasetName",
"Domain",
"DatasetType",
"Schema"
],
"members":{
"DatasetName":{
"shape":"Name",
"documentation":"<p>A name for the dataset.</p>"
},
"Domain":{
"shape":"Domain",
"documentation":"<p>The domain associated with the dataset. The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>, and <code>demand</code> fields to be present in your data. For more information, see <a>howitworks-datasets-groups</a>.</p>"
},
"DatasetType":{
"shape":"DatasetType",
"documentation":"<p>The dataset type. Valid values depend on the chosen <code>Domain</code>.</p>"
},
"DataFrequency":{
"shape":"Frequency",
"documentation":"<p>The frequency of data collection.</p> <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes.</p>"
},
"Schema":{
"shape":"Schema",
"documentation":"<p>The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset <code>Domain</code> and <code>DatasetType</code> that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see <a>howitworks-domains-ds-types</a>.</p>"
},
"EncryptionConfig":{
"shape":"EncryptionConfig",
"documentation":"<p>An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.</p>"
}
}
},
"CreateDatasetResponse":{
"type":"structure",
"members":{
"DatasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
}
}
},
"CreateForecastExportJobRequest":{
"type":"structure",
"required":[
"ForecastExportJobName",
"ForecastArn",
"Destination"
],
"members":{
"ForecastExportJobName":{
"shape":"Name",
"documentation":"<p>The name for the forecast export job.</p>"
},
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast that you want to export.</p>"
},
"Destination":{
"shape":"DataDestination",
"documentation":"<p>The path to the Amazon S3 bucket where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the bucket.</p>"
}
}
},
"CreateForecastExportJobResponse":{
"type":"structure",
"members":{
"ForecastExportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the export job.</p>"
}
}
},
"CreateForecastRequest":{
"type":"structure",
"required":[
"ForecastName",
"PredictorArn"
],
"members":{
"ForecastName":{
"shape":"Name",
"documentation":"<p>The name for the forecast.</p>"
},
"PredictorArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.</p>"
}
}
},
"CreateForecastResponse":{
"type":"structure",
"members":{
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast.</p>"
}
}
},
"CreatePredictorRequest":{
"type":"structure",
"required":[
"PredictorName",
"ForecastHorizon",
"InputDataConfig",
"FeaturizationConfig"
],
"members":{
"PredictorName":{
"shape":"Name",
"documentation":"<p>A name for the predictor.</p>"
},
"AlgorithmArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if <code>PerformAutoML</code> is not set to <code>true</code>.</p> <p class=\"title\"> <b>Supported algorithms</b> </p> <ul> <li> <p> <code>arn:aws:forecast:::algorithm/ARIMA</code> </p> </li> <li> <p> <code>arn:aws:forecast:::algorithm/Deep_AR_Plus</code> </p> <p> <code>- supports hyperparameter optimization (HPO)</code> </p> </li> <li> <p> <code>arn:aws:forecast:::algorithm/ETS</code> </p> </li> <li> <p> <code>arn:aws:forecast:::algorithm/NPTS</code> </p> </li> <li> <p> <code>arn:aws:forecast:::algorithm/Prophet</code> </p> </li> </ul>"
},
"ForecastHorizon":{
"shape":"Integer",
"documentation":"<p>Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.</p> <p>For example, if you configure a dataset for daily data collection (using the <code>DataFrequency</code> parameter of the <a>CreateDataset</a> operation) and set the forecast horizon to 10, the model returns predictions for 10 days.</p>"
},
"PerformAutoML":{
"shape":"Boolean",
"documentation":"<p>Whether to perform AutoML. The default value is <code>false</code>. In this case, you are required to specify an algorithm.</p> <p>If you want Amazon Forecast to evaluate the algorithms it provides and choose the best algorithm and configuration for your training dataset, set <code>PerformAutoML</code> to <code>true</code>. This is a good option if you aren't sure which algorithm is suitable for your application.</p>"
},
"PerformHPO":{
"shape":"Boolean",
"documentation":"<p>Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as a hyperparameter tuning job.</p> <p>The default value is <code>false</code>. In this case, Amazon Forecast uses default hyperparameter values from the chosen algorithm.</p> <p>To override the default values, set <code>PerformHPO</code> to <code>true</code> and supply the <a>HyperParameterTuningJobConfig</a> object. The tuning job specifies an objective metric, the hyperparameters to optimize, and the valid range for each hyperparameter.</p> <p>The following algorithms support HPO:</p> <ul> <li> <p>DeepAR+</p> </li> </ul>"
},
"TrainingParameters":{
"shape":"TrainingParameters",
"documentation":"<p>The training parameters to override for model training. The parameters that you can override are listed in the individual algorithms in <a>aws-forecast-choosing-recipes</a>.</p>"
},
"EvaluationParameters":{
"shape":"EvaluationParameters",
"documentation":"<p>Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.</p>"
},
"HPOConfig":{
"shape":"HyperParameterTuningJobConfig",
"documentation":"<p>Provides hyperparameter override values for the algorithm. If you don't provide this parameter, Amazon Forecast uses default values. The individual algorithms specify which hyperparameters support hyperparameter optimization (HPO). For more information, see <a>aws-forecast-choosing-recipes</a>.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Describes the dataset group that contains the data to use to train the predictor.</p>"
},
"FeaturizationConfig":{
"shape":"FeaturizationConfig",
"documentation":"<p>The featurization configuration.</p>"
},
"EncryptionConfig":{
"shape":"EncryptionConfig",
"documentation":"<p>An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.</p>"
}
}
},
"CreatePredictorResponse":{
"type":"structure",
"members":{
"PredictorArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the predictor.</p>"
}
}
},
"DataDestination":{
"type":"structure",
"required":["S3Config"],
"members":{
"S3Config":{
"shape":"S3Config",
"documentation":"<p>The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.</p>"
}
},
"documentation":"<p>The destination of an exported forecast and credentials to access the location. This object is submitted in the <a>CreateForecastExportJob</a> request.</p>"
},
"DataSource":{
"type":"structure",
"required":["S3Config"],
"members":{
"S3Config":{
"shape":"S3Config",
"documentation":"<p>The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.</p>"
}
},
"documentation":"<p>The source of your training data and credentials to access the data. This object is submitted in the <a>CreateDatasetImportJob</a> request.</p>"
},
"DatasetGroupSummary":{
"type":"structure",
"members":{
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group.</p>"
},
"DatasetGroupName":{
"shape":"Name",
"documentation":"<p>The name of the dataset group.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the datase group was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset group was created or last updated from a call to the <a>UpdateDatasetGroup</a> operation. While the dataset group is being updated, <code>LastModificationTime</code> is the current query time.</p>"
}
},
"documentation":"<p>Provides a summary of the dataset group properties used in the <a>ListDatasetGroups</a> operation. To get the complete set of properties, call the <a>DescribeDatasetGroup</a> operation, and provide the listed <code>DatasetGroupArn</code>.</p>"
},
"DatasetGroups":{
"type":"list",
"member":{"shape":"DatasetGroupSummary"}
},
"DatasetImportJobSummary":{
"type":"structure",
"members":{
"DatasetImportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset import job.</p>"
},
"DatasetImportJobName":{
"shape":"Name",
"documentation":"<p>The name of the dataset import job.</p>"
},
"DataSource":{
"shape":"DataSource",
"documentation":"<p>The location of the Amazon S3 bucket that contains the training data.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the dataset is <code>UPDATE_IN_PROGRESS</code>. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>"
},
"Message":{
"shape":"ErrorMessage",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset import job was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Dependent on the status as follows:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - same as <code>CreationTime</code> </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - the current timestamp</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - when the job finished or failed</p> </li> </ul>"
}
},
"documentation":"<p>Provides a summary of the dataset import job properties used in the <a>ListDatasetImportJobs</a> operation. To get the complete set of properties, call the <a>DescribeDatasetImportJob</a> operation, and provide the listed <code>DatasetImportJobArn</code>.</p>"
},
"DatasetImportJobs":{
"type":"list",
"member":{"shape":"DatasetImportJobSummary"}
},
"DatasetSummary":{
"type":"structure",
"members":{
"DatasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DatasetName":{
"shape":"Name",
"documentation":"<p>The name of the dataset.</p>"
},
"DatasetType":{
"shape":"DatasetType",
"documentation":"<p>The dataset type.</p>"
},
"Domain":{
"shape":"Domain",
"documentation":"<p>The domain associated with the dataset.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset is created, <code>LastModificationTime</code> is the same as <code>CreationTime</code>. After a <a>CreateDatasetImportJob</a> operation is called, <code>LastModificationTime</code> is when the import job finished or failed. While data is being imported to the dataset, <code>LastModificationTime</code> is the current query time.</p>"
}
},
"documentation":"<p>Provides a summary of the dataset properties used in the <a>ListDatasets</a> operation. To get the complete set of properties, call the <a>DescribeDataset</a> operation, and provide the listed <code>DatasetArn</code>.</p>"
},
"DatasetType":{
"type":"string",
"enum":[
"TARGET_TIME_SERIES",
"RELATED_TIME_SERIES",
"ITEM_METADATA"
]
},
"Datasets":{
"type":"list",
"member":{"shape":"DatasetSummary"}
},
"DeleteDatasetGroupRequest":{
"type":"structure",
"required":["DatasetGroupArn"],
"members":{
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group to delete.</p>"
}
}
},
"DeleteDatasetImportJobRequest":{
"type":"structure",
"required":["DatasetImportJobArn"],
"members":{
"DatasetImportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset import job to delete.</p>"
}
}
},
"DeleteDatasetRequest":{
"type":"structure",
"required":["DatasetArn"],
"members":{
"DatasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset to delete.</p>"
}
}
},
"DeleteForecastExportJobRequest":{
"type":"structure",
"required":["ForecastExportJobArn"],
"members":{
"ForecastExportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast export job to delete.</p>"
}
}
},
"DeleteForecastRequest":{
"type":"structure",
"required":["ForecastArn"],
"members":{
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast to delete.</p>"
}
}
},
"DeletePredictorRequest":{
"type":"structure",
"required":["PredictorArn"],
"members":{
"PredictorArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the predictor to delete.</p>"
}
}
},
"DescribeDatasetGroupRequest":{
"type":"structure",
"required":["DatasetGroupArn"],
"members":{
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group.</p>"
}
}
},
"DescribeDatasetGroupResponse":{
"type":"structure",
"members":{
"DatasetGroupName":{
"shape":"Name",
"documentation":"<p>The name of the dataset group.</p>"
},
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the dataset group.</p>"
},
"DatasetArns":{
"shape":"ArnList",
"documentation":"<p>An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.</p>"
},
"Domain":{
"shape":"Domain",
"documentation":"<p>The domain associated with the dataset group. The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>, and <code>demand</code> fields to be present in your data. For more information, see <a>howitworks-datasets-groups</a>.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the dataset group. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <p>The <code>UPDATE</code> states apply when the <a>UpdateDatasetGroup</a> operation is called.</p> <note> <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before creating a predictor using the dataset group.</p> </note>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset group was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset group was created or last updated from a call to the <a>UpdateDatasetGroup</a> operation. While the dataset group is being updated, <code>LastModificationTime</code> is the current query time.</p>"
}
}
},
"DescribeDatasetImportJobRequest":{
"type":"structure",
"required":["DatasetImportJobArn"],
"members":{
"DatasetImportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset import job.</p>"
}
}
},
"DescribeDatasetImportJobResponse":{
"type":"structure",
"members":{
"DatasetImportJobName":{
"shape":"Name",
"documentation":"<p>The name of the dataset import job.</p>"
},
"DatasetImportJobArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the dataset import job.</p>"
},
"DatasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset that the training data was imported to.</p>"
},
"TimestampFormat":{
"shape":"TimestampFormat",
"documentation":"<p>The format of timestamps in the dataset. Two formats are supported dependent on the <code>DataFrequency</code> specified when the dataset was created.</p> <ul> <li> <p>\"yyyy-MM-dd\"</p> <p>For data frequencies: Y, M, W, and D</p> </li> <li> <p>\"yyyy-MM-dd HH:mm:ss\"</p> <p>For data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D</p> </li> </ul>"
},
"DataSource":{
"shape":"DataSource",
"documentation":"<p>The location of the training data to import. The training data must be stored in an Amazon S3 bucket.</p>"
},
"FieldStatistics":{
"shape":"FieldStatistics",
"documentation":"<p>Statistical information about each field in the input data.</p>"
},
"DataSize":{
"shape":"Double",
"documentation":"<p>The size of the dataset in gigabytes (GB) after completion of the import job.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the dataset is <code>UPDATE_IN_PROGRESS</code>. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>"
},
"Message":{
"shape":"Message",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset import job was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Dependent on the status as follows:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - same as <code>CreationTime</code> </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - the current timestamp</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - when the job finished or failed</p> </li> </ul>"
}
}
},
"DescribeDatasetRequest":{
"type":"structure",
"required":["DatasetArn"],
"members":{
"DatasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
}
}
},
"DescribeDatasetResponse":{
"type":"structure",
"members":{
"DatasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DatasetName":{
"shape":"Name",
"documentation":"<p>The name of the dataset.</p>"
},
"Domain":{
"shape":"Domain",
"documentation":"<p>The dataset domain.</p>"
},
"DatasetType":{
"shape":"DatasetType",
"documentation":"<p>The dataset type.</p>"
},
"DataFrequency":{
"shape":"Frequency",
"documentation":"<p>The frequency of data collection.</p> <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"M\" indicates every month and \"30min\" indicates every 30 minutes.</p>"
},
"Schema":{
"shape":"Schema",
"documentation":"<p>An array of <code>SchemaAttribute</code> objects that specify the dataset fields. Each <code>SchemaAttribute</code> specifies the name and data type of a field.</p>"
},
"EncryptionConfig":{
"shape":"EncryptionConfig",
"documentation":"<p>An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the dataset. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <p>The <code>UPDATE</code> states apply while data is imported to the dataset from a call to the <a>CreateDatasetImportJob</a> operation. During this time, the status reflects the status of the dataset import job. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the dataset is <code>UPDATE_IN_PROGRESS</code>.</p> <note> <p>The <code>Status</code> of the dataset must be <code>ACTIVE</code> before you can import training data.</p> </note>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the dataset is created, <code>LastModificationTime</code> is the same as <code>CreationTime</code>. After a <a>CreateDatasetImportJob</a> operation is called, <code>LastModificationTime</code> is when the import job finished or failed. While data is being imported to the dataset, <code>LastModificationTime</code> is the current query time.</p>"
}
}
},
"DescribeForecastExportJobRequest":{
"type":"structure",
"required":["ForecastExportJobArn"],
"members":{
"ForecastExportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast export job.</p>"
}
}
},
"DescribeForecastExportJobResponse":{
"type":"structure",
"members":{
"ForecastExportJobArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the forecast export job.</p>"
},
"ForecastExportJobName":{
"shape":"Name",
"documentation":"<p>The name of the forecast export job.</p>"
},
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the exported forecast.</p>"
},
"Destination":{
"shape":"DataDestination",
"documentation":"<p>The path to the AWS S3 bucket where the forecast is exported.</p>"
},
"Message":{
"shape":"Message",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the forecast export job. One of the following states:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your Amazon S3 bucket.</p> </note>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the forecast export job was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the last successful export job finished.</p>"
}
}
},
"DescribeForecastRequest":{
"type":"structure",
"required":["ForecastArn"],
"members":{
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast.</p>"
}
}
},
"DescribeForecastResponse":{
"type":"structure",
"members":{
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The same forecast ARN as given in the request.</p>"
},
"ForecastName":{
"shape":"Name",
"documentation":"<p>The name of the forecast.</p>"
},
"PredictorArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the predictor used to generate the forecast.</p>"
},
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the dataset group that provided the data used to train the predictor.</p>"
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the forecast. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the forecast creation task was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (status is <code>CREATE_PENDING</code>). Updated when inference (creating the forecast) starts (status changed to <code>CREATE_IN_PROGRESS</code>), and when inference is complete (status changed to <code>ACTIVE</code>) or fails (status changed to <code>CREATE_FAILED</code>).</p>"
}
}
},
"DescribePredictorRequest":{
"type":"structure",
"required":["PredictorArn"],
"members":{
"PredictorArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the predictor that you want information about.</p>"
}
}
},
"DescribePredictorResponse":{
"type":"structure",
"members":{
"PredictorArn":{
"shape":"Name",
"documentation":"<p>The ARN of the predictor.</p>"
},
"PredictorName":{
"shape":"Name",
"documentation":"<p>The name of the predictor.</p>"
},
"AlgorithmArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the algorithm used for model training.</p>"
},
"ForecastHorizon":{
"shape":"Integer",
"documentation":"<p>The number of time-steps of the forecast. The forecast horizon is also called the prediction length.</p>"
},
"PerformAutoML":{
"shape":"Boolean",
"documentation":"<p>Whether the predictor is set to perform AutoML.</p>"
},
"PerformHPO":{
"shape":"Boolean",
"documentation":"<p>Whether the predictor is set to perform HPO.</p>"
},
"TrainingParameters":{
"shape":"TrainingParameters",
"documentation":"<p>The training parameters to override for model training. The parameters that you can override are listed in the individual algorithms in <a>aws-forecast-choosing-recipes</a>.</p>"
},
"EvaluationParameters":{
"shape":"EvaluationParameters",
"documentation":"<p>Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.</p>"
},
"HPOConfig":{
"shape":"HyperParameterTuningJobConfig",
"documentation":"<p>The hyperparameter override values for the algorithm.</p>"
},
"InputDataConfig":{
"shape":"InputDataConfig",
"documentation":"<p>Describes the dataset group that contains the data to use to train the predictor.</p>"
},
"FeaturizationConfig":{
"shape":"FeaturizationConfig",
"documentation":"<p>The featurization configuration.</p>"
},
"EncryptionConfig":{
"shape":"EncryptionConfig",
"documentation":"<p>An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.</p>"
},
"DatasetImportJobArns":{
"shape":"ArnList",
"documentation":"<p>An array of ARNs of the dataset import jobs used to import training data for the predictor.</p>"
},
"AutoMLAlgorithmArns":{
"shape":"ArnList",
"documentation":"<p>When <code>PerformAutoML</code> is specified, the ARN of the chosen algorithm.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the predictor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before using the predictor to create a forecast.</p> </note>"
},
"Message":{
"shape":"Message",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the model training task was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (status is <code>CREATE_PENDING</code>). Updated when training starts (status changed to <code>CREATE_IN_PROGRESS</code>), and when training is complete (status changed to <code>ACTIVE</code>) or fails (status changed to <code>CREATE_FAILED</code>).</p>"
}
}
},
"Domain":{
"type":"string",
"enum":[
"RETAIL",
"CUSTOM",
"INVENTORY_PLANNING",
"EC2_CAPACITY",
"WORK_FORCE",
"WEB_TRAFFIC",
"METRICS"
]
},
"Double":{"type":"double"},
"EncryptionConfig":{
"type":"structure",
"required":[
"RoleArn",
"KMSKeyArn"
],
"members":{
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the AWS KMS key.</p> <p>Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an <code>InvalidInputException</code> is thrown.</p>"
},
"KMSKeyArn":{
"shape":"KMSKeyArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.</p>"
}
},
"documentation":"<p>An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. This object is optionally submitted in the <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>"
},
"ErrorMessage":{"type":"string"},
"EvaluationParameters":{
"type":"structure",
"members":{
"NumberOfBacktestWindows":{
"shape":"Integer",
"documentation":"<p>The number of times to split the input data. The default is 1. The range is 1 through 5.</p>"
},
"BackTestWindowOffset":{
"shape":"Integer",
"documentation":"<p>The point from the end of the dataset where you want to split the data for model training and evaluation. The value is specified as the number of data points.</p>"
}
},
"documentation":"<p>Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms and can be overridden in the <a>CreatePredictor</a> request.</p> <p>For example, suppose that you have a dataset with data collection frequency set to every day and you have 200 days worth of data (that is, 200 data points). Now suppose that you set the <code>NumberOfBacktestWindows</code> to 2 and the <code>BackTestWindowOffset</code> parameter to 20. The algorithm splits the data twice. The first time, the algorithm trains the model using the first 180 data points and uses the last 20 data points for evaluation. The second time, the algorithm trains the model using the first 160 data points and uses the last 40 data points for evaluation.</p>"
},
"EvaluationResult":{
"type":"structure",
"members":{
"AlgorithmArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the algorithm that was evaluated.</p>"
},
"TestWindows":{
"shape":"TestWindows",
"documentation":"<p>The array of test windows used for evaluating the algorithm. The <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a> object determines the number of windows in the array.</p>"
}
},
"documentation":"<p>The results of evaluating an algorithm. Returned as part of the <a>GetAccuracyMetrics</a> response.</p>"
},
"EvaluationType":{
"type":"string",
"enum":[
"SUMMARY",
"COMPUTED"
]
},
"Featurization":{
"type":"structure",
"required":["AttributeName"],
"members":{
"AttributeName":{
"shape":"Name",
"documentation":"<p>The name of the schema attribute specifying the data field to be featurized. In this release, only the <code>target</code> field of the <code>TARGET_TIME_SERIES</code> dataset type is supported. For example, for the <code>RETAIL</code> domain, the target is <code>demand</code>, and for the <code>CUSTOM</code> domain, the target is <code>target_value</code>.</p>"
},
"FeaturizationPipeline":{
"shape":"FeaturizationPipeline",
"documentation":"<p>An array <code>FeaturizationMethod</code> objects that specifies the feature transformation methods. For this release, the number of methods is limited to one.</p>"
}
},
"documentation":"<p>Provides featurization (transformation) information for a dataset field. This object is part of the <a>FeaturizationConfig</a> object.</p> <p>For example:</p> <p> <code>{</code> </p> <p> <code>\"AttributeName\": \"demand\",</code> </p> <p> <code>FeaturizationPipeline [ {</code> </p> <p> <code>\"FeaturizationMethodName\": \"filling\",</code> </p> <p> <code>\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}</code> </p> <p> <code>} ]</code> </p> <p> <code>}</code> </p>"
},
"FeaturizationConfig":{
"type":"structure",
"required":["ForecastFrequency"],
"members":{
"ForecastFrequency":{
"shape":"Frequency",
"documentation":"<p>The frequency of predictions in a forecast.</p> <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.</p>"
},
"ForecastDimensions":{
"shape":"ForecastDimensions",
"documentation":"<p>An array of dimension (field) names that specify how to group the generated forecast.</p> <p>For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a <code>store_id</code> field. If you want the sales forecast for each item by store, you would specify <code>store_id</code> as the dimension.</p>"
},
"Featurizations":{
"shape":"Featurizations",
"documentation":"<p>An array of featurization (transformation) information for the fields of a dataset. In this release, only a single featurization is supported.</p>"
}
},
"documentation":"<p>In a <a>CreatePredictor</a> operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as <i>featurization</i>.</p> <p>You define featurization using the <code>FeaturizationConfig</code> object. You specify an array of transformations, one for each field that you want to featurize. You then include the <code>FeaturizationConfig</code> in your <code>CreatePredictor</code> request. Amazon Forecast applies the featurization to the <code>TARGET_TIME_SERIES</code> dataset before model training.</p> <p>You can create multiple featurization configurations. For example, you might call the <code>CreatePredictor</code> operation twice by specifying different featurization configurations.</p>"
},
"FeaturizationMethod":{
"type":"structure",
"required":["FeaturizationMethodName"],
"members":{
"FeaturizationMethodName":{
"shape":"FeaturizationMethodName",
"documentation":"<p>The name of the method. In this release, \"filling\" is the only supported method.</p>"
},
"FeaturizationMethodParameters":{
"shape":"FeaturizationMethodParameters",
"documentation":"<p>The method parameters (key-value pairs). Specify these to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.</p> <ul> <li> <p> <code>aggregation</code>: <b>sum</b>, <code>avg</code>, <code>first</code>, <code>min</code>, <code>max</code> </p> </li> <li> <p> <code>frontfill</code>: <b>none</b> </p> </li> <li> <p> <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not a number)</p> </li> <li> <p> <code>backfill</code>: <b>zero</b>, <code>nan</code> </p> </li> </ul>"
}
},
"documentation":"<p>Provides information about a method that featurizes (transforms) a dataset field. The method is part of the <code>FeaturizationPipeline</code> of the <a>Featurization</a> object. If <code>FeaturizationMethodParameters</code> isn't specified, Amazon Forecast uses default parameters.</p> <p>For example:</p> <p> <code>{</code> </p> <p> <code>\"FeaturizationMethodName\": \"filling\",</code> </p> <p> <code>\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}</code> </p> <p> <code>}</code> </p>"
},
"FeaturizationMethodName":{
"type":"string",
"enum":["filling"]
},
"FeaturizationMethodParameters":{
"type":"map",
"key":{"shape":"ParameterKey"},
"value":{"shape":"ParameterValue"},
"max":20,
"min":1
},
"FeaturizationPipeline":{
"type":"list",
"member":{"shape":"FeaturizationMethod"},
"max":1,
"min":1
},
"Featurizations":{
"type":"list",
"member":{"shape":"Featurization"},
"max":1,
"min":1
},
"FieldStatistics":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"Statistics"}
},
"Filter":{
"type":"structure",
"required":[
"Key",
"Value",
"Condition"
],
"members":{
"Key":{
"shape":"String",
"documentation":"<p>The name of the parameter to filter on.</p>"
},
"Value":{
"shape":"Arn",
"documentation":"<p>A valid value for <code>Key</code>.</p>"
},
"Condition":{
"shape":"FilterConditionString",
"documentation":"<p>The condition to apply.</p>"
}
},
"documentation":"<p>Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, the objects that match the statement. The match statement consists of a key and a value.</p>"
},
"FilterConditionString":{
"type":"string",
"enum":[
"IS",
"IS_NOT"
]
},
"Filters":{
"type":"list",
"member":{"shape":"Filter"}
},
"ForecastDimensions":{
"type":"list",
"member":{"shape":"Name"},
"max":5,
"min":1
},
"ForecastExportJobSummary":{
"type":"structure",
"members":{
"ForecastExportJobArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast export job.</p>"
},
"ForecastExportJobName":{
"shape":"Name",
"documentation":"<p>The name of the forecast export job.</p>"
},
"Destination":{
"shape":"DataDestination",
"documentation":"<p>The path to the S3 bucket where the forecast is stored.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the forecast export job. One of the following states:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your Amazon S3 bucket.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the forecast export job was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the last successful export job finished.</p>"
}
},
"documentation":"<p>Provides a summary of the forecast export job properties used in the <a>ListForecastExportJobs</a> operation. To get the complete set of properties, call the <a>DescribeForecastExportJob</a> operation, and provide the listed <code>ForecastExportJobArn</code>.</p>"
},
"ForecastExportJobs":{
"type":"list",
"member":{"shape":"ForecastExportJobSummary"}
},
"ForecastSummary":{
"type":"structure",
"members":{
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the forecast.</p>"
},
"ForecastName":{
"shape":"Name",
"documentation":"<p>The name of the forecast.</p>"
},
"PredictorArn":{
"shape":"String",
"documentation":"<p>The ARN of the predictor used to generate the forecast.</p>"
},
"DatasetGroupArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the forecast. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the forecast creation task was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (status is <code>CREATE_PENDING</code>). Updated when inference (creating the forecast) starts (status changed to <code>CREATE_IN_PROGRESS</code>), and when inference is complete (status changed to <code>ACTIVE</code>) or fails (status changed to <code>CREATE_FAILED</code>).</p>"
}
},
"documentation":"<p>Provides a summary of the forecast properties used in the <a>ListForecasts</a> operation. To get the complete set of properties, call the <a>DescribeForecast</a> operation, and provide the listed <code>ForecastArn</code>.</p>"
},
"Forecasts":{
"type":"list",
"member":{"shape":"ForecastSummary"}
},
"Frequency":{
"type":"string",
"pattern":"^Y|M|W|D|H|30min|15min|10min|5min|1min$"
},
"GetAccuracyMetricsRequest":{
"type":"structure",
"required":["PredictorArn"],
"members":{
"PredictorArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the predictor to get metrics for.</p>"
}
}
},
"GetAccuracyMetricsResponse":{
"type":"structure",
"members":{
"PredictorEvaluationResults":{
"shape":"PredictorEvaluationResults",
"documentation":"<p>An array of results from evaluating the predictor.</p>"
}
}
},
"HyperParameterTuningJobConfig":{
"type":"structure",
"members":{
"ParameterRanges":{
"shape":"ParameterRanges",
"documentation":"<p>Specifies the ranges of valid values for the hyperparameters.</p>"
}
},
"documentation":"<p>Configuration information for a hyperparameter tuning job. This object is specified in the <a>CreatePredictor</a> request.</p> <p>A hyperparameter is a parameter that governs the model training process and is set before training starts. This is as opposed to a model parameter that is determined during training. The values of the hyperparameters have an effect on the chosen model parameters.</p> <p>A hyperparameter tuning job is the process of choosing the optimum set of hyperparameter values that optimize a specified metric. This is accomplished by running many training jobs over a range of hyperparameter values. The optimum set of values is dependent on the algorithm, the training data, and the given metric objective.</p>"
},
"InputDataConfig":{
"type":"structure",
"required":["DatasetGroupArn"],
"members":{
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group.</p>"
},
"SupplementaryFeatures":{
"shape":"SupplementaryFeatures",
"documentation":"<p>An array of supplementary features. For this release, the only supported feature is a holiday calendar.</p>"
}
},
"documentation":"<p>The data used to train a predictor. The data includes a dataset group and any supplementary features. This object is specified in the <a>CreatePredictor</a> request.</p>"
},
"Integer":{"type":"integer"},
"IntegerParameterRange":{
"type":"structure",
"required":[
"Name",
"MaxValue",
"MinValue"
],
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the hyperparameter to tune.</p>"
},
"MaxValue":{
"shape":"Integer",
"documentation":"<p>The maximum tunable value of the hyperparameter.</p>"
},
"MinValue":{
"shape":"Integer",
"documentation":"<p>The minimum tunable value of the hyperparameter.</p>"
},
"ScalingType":{
"shape":"ScalingType",
"documentation":"<p>The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type\">Hyperparameter Scaling</a>. One of the following values:</p> <dl> <dt>Auto</dt> <dd> <p>Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.</p> </dd> <dt>Linear</dt> <dd> <p>Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.</p> </dd> <dt>Logarithmic</dt> <dd> <p>Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.</p> <p>Logarithmic scaling works only for ranges that have only values greater than 0.</p> </dd> <dt>ReverseLogarithmic</dt> <dd> <p>Not supported for <code>IntegerParameterRange</code>.</p> <p>Reverse logarithmic scaling works only for ranges that are entirely within the range 0 &lt;= x &lt; 1.0.</p> </dd> </dl>"
}
},
"documentation":"<p>Specifies an integer hyperparameter and it's range of tunable values. This object is part of the <a>ParameterRanges</a> object.</p>"
},
"IntegerParameterRanges":{
"type":"list",
"member":{"shape":"IntegerParameterRange"},
"max":20,
"min":1
},
"InvalidInputException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>We can't process the request because it includes an invalid value or a value that exceeds the valid range.</p>",
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The token is not valid. Tokens expire after 24 hours.</p>",
"exception":true
},
"KMSKeyArn":{
"type":"string",
"max":256,
"pattern":"arn:aws:kms:.*:key/.*"
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The limit on the number of requests per second has been exceeded.</p>",
"exception":true
},
"ListDatasetGroupsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The number of items to return in the response.</p>"
}
}
},
"ListDatasetGroupsResponse":{
"type":"structure",
"members":{
"DatasetGroups":{
"shape":"DatasetGroups",
"documentation":"<p>An array of objects that summarize each dataset group's properties.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>"
}
}
},
"ListDatasetImportJobsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The number of items to return in the response.</p>"
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>DatasetImportJobName</code> property.</p> <ul> <li> <p> <code>Condition</code> - <code>IS</code> or <code>IS_NOT</code> </p> </li> <li> <p> <code>Key</code> - <code>Name</code> </p> </li> <li> <p> <code>Value</code> - the value to match</p> </li> </ul> <p>For example, to list all dataset import jobs named <i>my_dataset_import_job</i>, you would specify:</p> <p> <code>\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_dataset_import_job\" } ]</code> </p>"
}
}
},
"ListDatasetImportJobsResponse":{
"type":"structure",
"members":{
"DatasetImportJobs":{
"shape":"DatasetImportJobs",
"documentation":"<p>An array of objects that summarize each dataset import job's properties.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>"
}
}
},
"ListDatasetsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The number of items to return in the response.</p>"
}
}
},
"ListDatasetsResponse":{
"type":"structure",
"members":{
"Datasets":{
"shape":"Datasets",
"documentation":"<p>An array of objects that summarize each dataset's properties.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>"
}
}
},
"ListForecastExportJobsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The number of items to return in the response.</p>"
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>ForecastExportJobName</code> property.</p> <ul> <li> <p> <code>Condition</code> - <code>IS</code> or <code>IS_NOT</code> </p> </li> <li> <p> <code>Key</code> - <code>Name</code> </p> </li> <li> <p> <code>Value</code> - the value to match</p> </li> </ul> <p>For example, to list all forecast export jobs named <i>my_forecast_export_job</i>, you would specify:</p> <p> <code>\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_forecast_export_job\" } ]</code> </p>"
}
}
},
"ListForecastExportJobsResponse":{
"type":"structure",
"members":{
"ForecastExportJobs":{
"shape":"ForecastExportJobs",
"documentation":"<p>An array of objects that summarize each export job's properties.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>"
}
}
},
"ListForecastsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The number of items to return in the response.</p>"
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>ForecastName</code> property.</p> <ul> <li> <p> <code>Condition</code> - <code>IS</code> or <code>IS_NOT</code> </p> </li> <li> <p> <code>Key</code> - <code>Name</code> </p> </li> <li> <p> <code>Value</code> - the value to match</p> </li> </ul> <p>For example, to list all forecasts named <i>my_forecast</i>, you would specify:</p> <p> <code>\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_forecast\" } ]</code> </p>"
}
}
},
"ListForecastsResponse":{
"type":"structure",
"members":{
"Forecasts":{
"shape":"Forecasts",
"documentation":"<p>An array of objects that summarize each forecast's properties.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>"
}
}
},
"ListPredictorsRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The number of items to return in the response.</p>"
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, <code>Name</code> is the only valid key, which filters on the <code>PredictorName</code> property.</p> <ul> <li> <p> <code>Condition</code> - <code>IS</code> or <code>IS_NOT</code> </p> </li> <li> <p> <code>Key</code> - <code>Name</code> </p> </li> <li> <p> <code>Value</code> - the value to match</p> </li> </ul> <p>For example, to list all predictors named <i>my_predictor</i>, you would specify:</p> <p> <code>\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_predictor\" } ]</code> </p>"
}
}
},
"ListPredictorsResponse":{
"type":"structure",
"members":{
"Predictors":{
"shape":"Predictors",
"documentation":"<p>An array of objects that summarize each predictor's properties.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>"
}
}
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"Message":{"type":"string"},
"Metrics":{
"type":"structure",
"members":{
"RMSE":{
"shape":"Double",
"documentation":"<p>The root mean square error (RMSE).</p>"
},
"WeightedQuantileLosses":{
"shape":"WeightedQuantileLosses",
"documentation":"<p>An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.</p>"
}
},
"documentation":"<p>Provides metrics used to evaluate the performance of a predictor. This object is part of the <a>WindowSummary</a> object.</p>"
},
"Name":{
"type":"string",
"max":63,
"min":1,
"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_]*"
},
"NextToken":{
"type":"string",
"max":3000,
"min":1
},
"ParameterKey":{
"type":"string",
"max":256,
"pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\[\\]\\,\\\\]+$"
},
"ParameterRanges":{
"type":"structure",
"members":{
"CategoricalParameterRanges":{
"shape":"CategoricalParameterRanges",
"documentation":"<p>Specifies the tunable range for each categorical hyperparameter.</p>"
},
"ContinuousParameterRanges":{
"shape":"ContinuousParameterRanges",
"documentation":"<p>Specifies the tunable range for each continuous hyperparameter.</p>"
},
"IntegerParameterRanges":{
"shape":"IntegerParameterRanges",
"documentation":"<p>Specifies the tunable range for each integer hyperparameter.</p>"
}
},
"documentation":"<p>Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the <a>HyperParameterTuningJobConfig</a> object.</p>"
},
"ParameterValue":{
"type":"string",
"max":256,
"pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\[\\]\\,\\\"\\\\\\s]+$"
},
"PredictorEvaluationResults":{
"type":"list",
"member":{"shape":"EvaluationResult"}
},
"PredictorSummary":{
"type":"structure",
"members":{
"PredictorArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the predictor.</p>"
},
"PredictorName":{
"shape":"Name",
"documentation":"<p>The name of the predictor.</p>"
},
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the predictor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before using the predictor to create a forecast.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
"documentation":"<p>If an error occurred, an informational message about the error.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>When the model training task was created.</p>"
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (status is <code>CREATE_PENDING</code>). Updated when training starts (status changed to <code>CREATE_IN_PROGRESS</code>), and when training is complete (status changed to <code>ACTIVE</code>) or fails (status changed to <code>CREATE_FAILED</code>).</p>"
}
},
"documentation":"<p>Provides a summary of the predictor properties used in the <a>ListPredictors</a> operation. To get the complete set of properties, call the <a>DescribePredictor</a> operation, and provide the listed <code>PredictorArn</code>.</p>"
},
"Predictors":{
"type":"list",
"member":{"shape":"PredictorSummary"}
},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.</p>",
"exception":true
},
"ResourceInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The specified resource is in use.</p>",
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.</p>",
"exception":true
},
"S3Config":{
"type":"structure",
"required":[
"Path",
"RoleArn"
],
"members":{
"Path":{
"shape":"S3Path",
"documentation":"<p>The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.</p>"
},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or file(s).</p> <p>Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an <code>InvalidInputException</code> is thrown.</p>"
},
"KMSKeyArn":{
"shape":"KMSKeyArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.</p>"
}
},
"documentation":"<p>The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is submitted in the <a>CreateDatasetImportJob</a> and <a>CreateForecastExportJob</a> requests.</p>"
},
"S3Path":{
"type":"string",
"pattern":"^s3://.+$"
},
"ScalingType":{
"type":"string",
"enum":[
"Auto",
"Linear",
"Logarithmic",
"ReverseLogarithmic"
]
},
"Schema":{
"type":"structure",
"members":{
"Attributes":{
"shape":"SchemaAttributes",
"documentation":"<p>An array of attributes specifying the name and type of each field in a dataset.</p>"
}
},
"documentation":"<p>Defines the fields of a dataset. This object is specified in the <a>CreateDataset</a> request.</p>"
},
"SchemaAttribute":{
"type":"structure",
"members":{
"AttributeName":{
"shape":"Name",
"documentation":"<p>The name of the dataset field.</p>"
},
"AttributeType":{
"shape":"AttributeType",
"documentation":"<p>The data type of the field.</p>"
}
},
"documentation":"<p>An attribute of a schema, which defines a field of a dataset. A schema attribute is required for every field in a dataset. The <a>Schema</a> object contains an array of <code>SchemaAttribute</code> objects.</p>"
},
"SchemaAttributes":{
"type":"list",
"member":{"shape":"SchemaAttribute"}
},
"Statistics":{
"type":"structure",
"members":{
"Count":{
"shape":"Integer",
"documentation":"<p>The number of values in the field.</p>"
},
"CountDistinct":{
"shape":"Integer",
"documentation":"<p>The number of distinct values in the field.</p>"
},
"CountNull":{
"shape":"Integer",
"documentation":"<p>The number of null values in the field.</p>"
},
"CountNan":{
"shape":"Integer",
"documentation":"<p>The number of NAN (not a number) values in the field.</p>"
},
"Min":{
"shape":"String",
"documentation":"<p>For a numeric field, the minimum value in the field.</p>"
},
"Max":{
"shape":"String",
"documentation":"<p>For a numeric field, the maximum value in the field.</p>"
},
"Avg":{
"shape":"Double",
"documentation":"<p>For a numeric field, the average value in the field.</p>"
},
"Stddev":{
"shape":"Double",
"documentation":"<p>For a numeric field, the standard deviation.</p>"
}
},
"documentation":"<p>Provides statistics for each data field imported to an Amazon Forecast dataset with the <a>CreateDatasetImportJob</a> operation.</p>"
},
"Status":{
"type":"string",
"max":256
},
"String":{
"type":"string",
"max":256,
"pattern":"^[a-zA-Z0-9\\_]+$"
},
"SupplementaryFeature":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The name of the feature. This must be \"holiday\".</p>"
},
"Value":{
"shape":"Value",
"documentation":"<p>One of the following 2 letter country codes:</p> <ul> <li> <p>\"AU\" - AUSTRALIA</p> </li> <li> <p>\"DE\" - GERMANY</p> </li> <li> <p>\"JP\" - JAPAN</p> </li> <li> <p>\"US\" - UNITED_STATES</p> </li> <li> <p>\"UK\" - UNITED_KINGDOM</p> </li> </ul>"
}
},
"documentation":"<p>Describes a supplementary feature of a dataset group. This object is part of the <a>InputDataConfig</a> object.</p> <p>For this release, the only supported feature is a holiday calendar. If the calendar is used, all data should belong to the same country as the calendar. For the calendar data, see <a href=\"http://jollyday.sourceforge.net/data.html\">http://jollyday.sourceforge.net/data.html</a>.</p>"
},
"SupplementaryFeatures":{
"type":"list",
"member":{"shape":"SupplementaryFeature"},
"max":1,
"min":1
},
"TestWindows":{
"type":"list",
"member":{"shape":"WindowSummary"}
},
"Timestamp":{"type":"timestamp"},
"TimestampFormat":{
"type":"string",
"max":256,
"pattern":"^[a-zA-Z0-9\\-\\:\\.\\,\\'\\s]+$"
},
"TrainingParameters":{
"type":"map",
"key":{"shape":"ParameterKey"},
"value":{"shape":"ParameterValue"},
"max":100,
"min":0
},
"UpdateDatasetGroupRequest":{
"type":"structure",
"required":[
"DatasetGroupArn",
"DatasetArns"
],
"members":{
"DatasetGroupArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the dataset group.</p>"
},
"DatasetArns":{
"shape":"ArnList",
"documentation":"<p>An array of Amazon Resource Names (ARNs) of the datasets to add to the dataset group.</p>"
}
}
},
"UpdateDatasetGroupResponse":{
"type":"structure",
"members":{
}
},
"Value":{
"type":"string",
"max":256,
"pattern":"^[a-zA-Z0-9\\_\\-]+$"
},
"Values":{
"type":"list",
"member":{"shape":"Value"},
"max":20,
"min":1
},
"WeightedQuantileLoss":{
"type":"structure",
"members":{
"Quantile":{
"shape":"Double",
"documentation":"<p>The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, if the distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>"
},
"LossValue":{
"shape":"Double",
"documentation":"<p>The difference between the predicted value and actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.</p>"
}
},
"documentation":"<p>The weighted loss value for a quantile. This object is part of the <a>Metrics</a> object.</p>"
},
"WeightedQuantileLosses":{
"type":"list",
"member":{"shape":"WeightedQuantileLoss"}
},
"WindowSummary":{
"type":"structure",
"members":{
"TestWindowStart":{
"shape":"Timestamp",
"documentation":"<p>The timestamp that defines the start of the window.</p>"
},
"TestWindowEnd":{
"shape":"Timestamp",
"documentation":"<p>The timestamp that defines the end of the window.</p>"
},
"ItemCount":{
"shape":"Integer",
"documentation":"<p>The number of data points within the window.</p>"
},
"EvaluationType":{
"shape":"EvaluationType",
"documentation":"<p>The type of evaluation.</p> <ul> <li> <p> <code>SUMMARY</code> - The average metrics across all windows.</p> </li> <li> <p> <code>COMPUTED</code> - The metrics for the specified window.</p> </li> </ul>"
},
"Metrics":{"shape":"Metrics"}
},
"documentation":"<p>The metrics for a time range within the evaluation portion of a dataset. This object is part of the <a>EvaluationResult</a> object.</p> <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are determined by the <code>BackTestWindowOffset</code> parameter of the <a>EvaluationParameters</a> object.</p>"
}
},
"documentation":"<p>Provides APIs for creating and managing Amazon Forecast resources.</p>"
}

3
botocore/data/forecastquery/2018-06-26/paginators-1.json Normal file
View file

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

190
botocore/data/forecastquery/2018-06-26/service-2.json Normal file
View file

@ -0,0 +1,190 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-06-26",
"endpointPrefix":"forecastquery",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Forecast Query Service",
"serviceId":"forecastquery",
"signatureVersion":"v4",
"signingName":"forecast",
"targetPrefix":"AmazonForecastRuntime",
"uid":"forecastquery-2018-06-26"
},
"operations":{
"QueryForecast":{
"name":"QueryForecast",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"QueryForecastRequest"},
"output":{"shape":"QueryForecastResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Retrieves a forecast filtered by the supplied criteria.</p> <p>The criteria is a key-value pair. The key is either <code>item_id</code> (or the equivalent non-timestamp, non-target field) from the <code>TARGET_TIME_SERIES</code> dataset, or one of the forecast dimensions specified as part of the <code>FeaturizationConfig</code> object.</p> <p>By default, the complete date range of the filtered forecast is returned. Optionally, you can request a specific date range within the forecast.</p> <note> <p>The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.</p> </note>"
}
},
"shapes":{
"Arn":{
"type":"string",
"max":256,
"pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+"
},
"AttributeName":{
"type":"string",
"max":256,
"pattern":"^[a-zA-Z0-9\\_\\-]+$"
},
"AttributeValue":{
"type":"string",
"max":256
},
"DataPoint":{
"type":"structure",
"members":{
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p>The timestamp of the specific forecast.</p>"
},
"Value":{
"shape":"Double",
"documentation":"<p>The forecast value.</p>"
}
},
"documentation":"<p>The forecast value for a specific date. Part of the <a>Forecast</a> object.</p>"
},
"DateTime":{
"type":"string",
"max":20,
"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$"
},
"Double":{"type":"double"},
"ErrorMessage":{"type":"string"},
"Filters":{
"type":"map",
"key":{"shape":"AttributeName"},
"value":{"shape":"AttributeValue"},
"max":50,
"min":1
},
"Forecast":{
"type":"structure",
"members":{
"Predictions":{
"shape":"Predictions",
"documentation":"<p>The forecast.</p> <p>The <i>string</i> of the string to array map is one of the following values:</p> <ul> <li> <p>mean</p> </li> <li> <p>p10</p> </li> <li> <p>p50</p> </li> <li> <p>p90</p> </li> </ul>"
}
},
"documentation":"<p>Provides information about a forecast. Returned as part of the <a>QueryForecast</a> response.</p>"
},
"InvalidInputException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The value that you provided was invalid or too long.</p>",
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The token is not valid. Tokens expire after 24 hours.</p>",
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The limit on the number of requests per second has been exceeded.</p>",
"exception":true
},
"NextToken":{
"type":"string",
"max":3000,
"min":1
},
"Predictions":{
"type":"map",
"key":{"shape":"Statistic"},
"value":{"shape":"TimeSeries"}
},
"QueryForecastRequest":{
"type":"structure",
"required":[
"ForecastArn",
"Filters"
],
"members":{
"ForecastArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the forecast to query.</p>"
},
"StartDate":{
"shape":"DateTime",
"documentation":"<p>The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format) For example, \"1970-01-01T00:00:00Z.\"</p>"
},
"EndDate":{
"shape":"DateTime",
"documentation":"<p>The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format). For example, \"1970-01-01T00:00:00Z.\" </p>"
},
"Filters":{
"shape":"Filters",
"documentation":"<p>The filtering criteria to apply when retrieving the forecast. For example:</p> <ul> <li> <p>To get a forecast for a specific item specify the following:</p> <p> <code>{\"item_id\" : \"client_1\"}</code> </p> </li> </ul> <ul> <li> <p>To get a forecast for a specific item sold in a specific location, specify the following:</p> <p> <code>{\"item_id\" : \"client_1\", \"location\" : \"ny\"}</code> </p> </li> </ul> <ul> <li> <p>To get a forecast for all blue items sold in a specific location, specify the following:</p> <p> <code>{ \"location\" : \"ny\", \"color\":\"blue\"}</code> </p> </li> </ul> <p>To get the full forecast, use the operation.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>"
}
}
},
"QueryForecastResponse":{
"type":"structure",
"members":{
"Forecast":{
"shape":"Forecast",
"documentation":"<p>The forecast.</p>"
}
}
},
"ResourceInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The specified resource is in use.</p>",
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>We can't find that resource. Check the information that you've provided and try again.</p>",
"exception":true
},
"Statistic":{
"type":"string",
"max":4
},
"TimeSeries":{
"type":"list",
"member":{"shape":"DataPoint"}
},
"Timestamp":{
"type":"string",
"max":20,
"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$"
}
},
"documentation":"<p>Provides APIs for creating and managing Amazon Forecast resources.</p>"
}

29
botocore/data/gamelift/2015-10-01/service-2.json
View file

@ -1383,6 +1383,20 @@
"FAILED"
]
},
"CertificateConfiguration":{
"type":"structure",
"required":["CertificateType"],
"members":{
"CertificateType":{"shape":"CertificateType"}
}
},
"CertificateType":{
"type":"string",
"enum":[
"DISABLED",
"GENERATED"
]
},
"ComparisonOperatorType":{
"type":"string",
"enum":[
@ -1546,7 +1560,8 @@
"InstanceRoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the <a href=\"https://console.aws.amazon.com/iam/\">IAM dashboard</a> in the AWS Management Console. Learn more about using on-box credentials for your game servers at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html\"> Access external resources from a game server</a>.</p>"
}
},
"CertificateConfiguration":{"shape":"CertificateConfiguration"}
},
"documentation":"<p>Represents the input for a request action.</p>"
},
@ -2722,6 +2737,7 @@
"type":"list",
"member":{"shape":"DesiredPlayerSession"}
},
"DnsName":{"type":"string"},
"Double":{"type":"double"},
"DoubleObject":{"type":"double"},
"EC2InstanceCounts":{
@ -2983,7 +2999,8 @@
"InstanceRoleArn":{
"shape":"NonEmptyString",
"documentation":"<p>Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the <a href=\"https://console.aws.amazon.com/iam/\">IAM dashboard</a> in the AWS Management Console. Learn more about using on-box credentials for your game servers at <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html\"> Access external resources from a game server</a>.</p>"
}
},
"CertificateConfiguration":{"shape":"CertificateConfiguration"}
},
"documentation":"<p>General properties describing a fleet.</p> <ul> <li> <p> <a>CreateFleet</a> </p> </li> <li> <p> <a>ListFleets</a> </p> </li> <li> <p> <a>DeleteFleet</a> </p> </li> <li> <p>Describe fleets:</p> <ul> <li> <p> <a>DescribeFleetAttributes</a> </p> </li> <li> <p> <a>DescribeFleetCapacity</a> </p> </li> <li> <p> <a>DescribeFleetPortSettings</a> </p> </li> <li> <p> <a>DescribeFleetUtilization</a> </p> </li> <li> <p> <a>DescribeRuntimeConfiguration</a> </p> </li> <li> <p> <a>DescribeEC2InstanceLimits</a> </p> </li> <li> <p> <a>DescribeFleetEvents</a> </p> </li> </ul> </li> <li> <p>Update fleets:</p> <ul> <li> <p> <a>UpdateFleetAttributes</a> </p> </li> <li> <p> <a>UpdateFleetCapacity</a> </p> </li> <li> <p> <a>UpdateFleetPortSettings</a> </p> </li> <li> <p> <a>UpdateRuntimeConfiguration</a> </p> </li> </ul> </li> <li> <p>Manage fleet actions:</p> <ul> <li> <p> <a>StartFleetActions</a> </p> </li> <li> <p> <a>StopFleetActions</a> </p> </li> </ul> </li> </ul>"
},
@ -3161,6 +3178,7 @@
"shape":"IpAddress",
"documentation":"<p>IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>"
},
"DnsName":{"shape":"DnsName"},
"Port":{
"shape":"PortNumber",
"documentation":"<p>Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>"
@ -3200,6 +3218,7 @@
"shape":"StringModel",
"documentation":"<p>IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>"
},
"DnsName":{"shape":"DnsName"},
"Port":{
"shape":"PositiveInteger",
"documentation":"<p>Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>"
@ -3301,6 +3320,7 @@
"shape":"IpAddress",
"documentation":"<p>IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is <code>FULFILLED</code>). </p>"
},
"DnsName":{"shape":"DnsName"},
"Port":{
"shape":"PortNumber",
"documentation":"<p>Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is <code>FULFILLED</code>).</p>"
@ -3326,7 +3346,8 @@
"PENDING",
"FULFILLED",
"CANCELLED",
"TIMED_OUT"
"TIMED_OUT",
"FAILED"
]
},
"GameSessionQueue":{
@ -3475,6 +3496,7 @@
"shape":"IpAddress",
"documentation":"<p>IP address assigned to the instance.</p>"
},
"DnsName":{"shape":"DnsName"},
"OperatingSystem":{
"shape":"OperatingSystem",
"documentation":"<p>Operating system that is running on this instance. </p>"
@ -4174,6 +4196,7 @@
"shape":"IpAddress",
"documentation":"<p>IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>"
},
"DnsName":{"shape":"DnsName"},
"Port":{
"shape":"PortNumber",
"documentation":"<p>Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.</p>"

54
botocore/data/globalaccelerator/2018-08-08/service-2.json
View file

@ -26,7 +26,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to <b>Example</b>.</p>"
"documentation":"<p>Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to <b>Example</b>.</p> <important> <p>You must specify the US-West-2 (Oregon) Region to create or update accelerators.</p> </important>"
},
"CreateEndpointGroup":{
"name":"CreateEndpointGroup",
@ -42,7 +42,8 @@
{"shape":"ListenerNotFoundException"},
{"shape":"InternalServiceErrorException"},
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to <b>Example</b>.</p>"
},
@ -87,6 +88,7 @@
},
"input":{"shape":"DeleteEndpointGroupRequest"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"EndpointGroupNotFoundException"},
{"shape":"InternalServiceErrorException"}
],
@ -100,6 +102,7 @@
},
"input":{"shape":"DeleteListenerRequest"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"ListenerNotFoundException"},
{"shape":"AssociatedEndpointGroupFoundException"},
{"shape":"InternalServiceErrorException"}
@ -145,6 +148,7 @@
"input":{"shape":"DescribeEndpointGroupRequest"},
"output":{"shape":"DescribeEndpointGroupResponse"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"EndpointGroupNotFoundException"},
{"shape":"InternalServiceErrorException"}
],
@ -174,6 +178,7 @@
"input":{"shape":"ListAcceleratorsRequest"},
"output":{"shape":"ListAcceleratorsResponse"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalServiceErrorException"}
],
@ -204,6 +209,7 @@
"input":{"shape":"ListListenersRequest"},
"output":{"shape":"ListListenersResponse"},
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"AcceleratorNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalServiceErrorException"}
@ -223,7 +229,7 @@
{"shape":"InternalServiceErrorException"},
{"shape":"InvalidArgumentException"}
],
"documentation":"<p>Update an accelerator.</p>"
"documentation":"<p>Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to <b>Example</b>.</p> <important> <p>You must specify the US-West-2 (Oregon) Region to create or update accelerators.</p> </important>"
},
"UpdateAcceleratorAttributes":{
"name":"UpdateAcceleratorAttributes",
@ -236,7 +242,8 @@
"errors":[
{"shape":"AcceleratorNotFoundException"},
{"shape":"InternalServiceErrorException"},
{"shape":"InvalidArgumentException"}
{"shape":"InvalidArgumentException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to <b>Example</b>.</p>"
},
@ -252,7 +259,8 @@
{"shape":"InvalidArgumentException"},
{"shape":"EndpointGroupNotFoundException"},
{"shape":"InternalServiceErrorException"},
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to <b>Example</b>.</p>"
},
@ -284,7 +292,7 @@
},
"Name":{
"shape":"GenericString",
"documentation":"<p>The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>"
"documentation":"<p>The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.</p>"
},
"IpAddressType":{
"shape":"IpAddressType",
@ -292,11 +300,15 @@
},
"Enabled":{
"shape":"GenericBoolean",
"documentation":"<p>Indicates whether theaccelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>"
"documentation":"<p>Indicates whether the accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.</p>"
},
"IpSets":{
"shape":"IpSets",
"documentation":"<p>IP address set associated with the accelerator.</p>"
"documentation":"<p>The static IP addresses that Global Accelerator associates with the accelerator.</p>"
},
"DnsName":{
"shape":"GenericString",
"documentation":"<p>The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses. </p> <p>The naming convention for the DNS name is: a lower case letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.</p> <p>For more information about the default DNS name, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing\">Support for DNS Addressing in Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
},
"Status":{
"shape":"AcceleratorStatus",
@ -358,6 +370,14 @@
"type":"list",
"member":{"shape":"Accelerator"}
},
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>You don't have access permission.</p>",
"exception":true
},
"AssociatedEndpointGroupFoundException":{
"type":"structure",
"members":{
@ -546,10 +566,11 @@
},
"DescribeAcceleratorAttributesRequest":{
"type":"structure",
"required":["AcceleratorArn"],
"members":{
"AcceleratorArn":{
"shape":"GenericString",
"documentation":"<p>The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe. Value is required.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.</p>"
}
}
},
@ -629,6 +650,10 @@
"Weight":{
"shape":"EndpointWeight",
"documentation":"<p>The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html\">Endpoint Weights</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
},
"ClientIPPreservationEnabled":{
"shape":"GenericBoolean",
"documentation":"<p>Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/introduction-how-it-works-client-ip.html\"> Viewing Client IP Addresses in AWS Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
}
},
"documentation":"<p>A complex type for endpoints.</p>"
@ -644,7 +669,7 @@
"members":{
"EndpointId":{
"shape":"GenericString",
"documentation":"<p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.</p>"
"documentation":"<p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. An Application Load Balancer can be either internal or internet-facing.</p>"
},
"Weight":{
"shape":"EndpointWeight",
@ -657,6 +682,10 @@
"HealthReason":{
"shape":"GenericString",
"documentation":"<p>The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.</p> <p>If the endpoint state is <b>unhealthy</b>, the reason code can be one of the following values:</p> <ul> <li> <p> <b>Timeout</b>: The health check requests to the endpoint are timing out before returning a status.</p> </li> <li> <p> <b>Failed</b>: The health check failed, for example because the endpoint response was invalid (malformed).</p> </li> </ul> <p>If the endpoint state is <b>initial</b>, the reason code can be one of the following values:</p> <ul> <li> <p> <b>ProvisioningInProgress</b>: The endpoint is in the process of being provisioned.</p> </li> <li> <p> <b>InitialHealthChecking</b>: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.</p> </li> </ul>"
},
"ClientIPPreservationEnabled":{
"shape":"GenericBoolean",
"documentation":"<p>Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/introduction-how-it-works-client-ip.html\"> Viewing Client IP Addresses in AWS Global Accelerator</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
}
},
"documentation":"<p>A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.</p>"
@ -1009,10 +1038,11 @@
},
"UpdateAcceleratorAttributesRequest":{
"type":"structure",
"required":["AcceleratorArn"],
"members":{
"AcceleratorArn":{
"shape":"GenericString",
"documentation":"<p>The Amazon Resource Name (ARN) of the accelerator that you want to update. Attribute is required.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the accelerator that you want to update.</p>"
},
"FlowLogsEnabled":{
"shape":"GenericBoolean",
@ -1147,5 +1177,5 @@
}
}
},
"documentation":"<fullname>AWS Global Accelerator</fullname> <p>This is the <i>AWS Global Accelerator API Reference</i>. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/Welcome.html\">AWS Global Accelerator Developer Guide</a>. </p> <p>AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience. </p> <p>Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.</p> <p>Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is directed to only healthy endpoints.</p> <p>Global Accelerator includes components that work together to help you improve performance and availability for your applications:</p> <dl> <dt>Static IP address</dt> <dd> <p>AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.</p> </dd> <dt>Accelerator</dt> <dd> <p>An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.</p> </dd> <dt>Network zone</dt> <dd> <p>A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.</p> </dd> <dt>Listener</dt> <dd> <p>A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.</p> </dd> <dt>Endpoint group</dt> <dd> <p>Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a <i>traffic dial</i>. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example. </p> </dd> <dt>Endpoint</dt> <dd> <p>An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.</p> </dd> </dl>"
"documentation":"<fullname>AWS Global Accelerator</fullname> <p>This is the <i>AWS Global Accelerator API Reference</i>. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/Welcome.html\">AWS Global Accelerator Developer Guide</a>. </p> <p>AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience. </p> <important> <p>You must specify the US-West-2 (Oregon) Region to create or update accelerators.</p> </important> <p>Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.</p> <p>Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is directed to only healthy endpoints.</p> <p>Global Accelerator includes components that work together to help you improve performance and availability for your applications:</p> <dl> <dt>Static IP address</dt> <dd> <p>AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.</p> </dd> <dt>Accelerator</dt> <dd> <p>An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.</p> </dd> <dt>Network zone</dt> <dd> <p>A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.</p> </dd> <dt>Listener</dt> <dd> <p>A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.</p> </dd> <dt>Endpoint group</dt> <dd> <p>Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a <i>traffic dial</i>. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example. </p> </dd> <dt>Endpoint</dt> <dd> <p>An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.</p> </dd> </dl>"
}

6
botocore/data/glue/2017-03-31/paginators-1.json
View file

@ -83,12 +83,6 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "SecurityConfigurations"
},
"GetJobBookmarks": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "JobBookmarkEntries"
}
}
}

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

@ -944,22 +944,6 @@
],
"documentation":"<p>Returns information on a job bookmark entry.</p>"
},
"GetJobBookmarks":{
"name":"GetJobBookmarks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetJobBookmarksRequest"},
"output":{"shape":"GetJobBookmarksResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"EntityNotFoundException"},
{"shape":"InternalServiceException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Returns information on the job bookmark entries. The list is ordered on decreasing version numbers.</p>"
},
"GetJobRun":{
"name":"GetJobRun",
"http":{
@ -3501,6 +3485,10 @@
"shape":"WorkerType",
"documentation":"<p>The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> </ul> <p>Known issue: when a development endpoint is created with the <code>G.2X</code> <code>WorkerType</code> configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. </p>"
},
"GlueVersion":{
"shape":"GlueVersionString",
"documentation":"<p>Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints. </p> <p>For more information about the available AWS Glue versions and corresponding Spark and Python versions, see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/add-job.html\">Glue version</a> in the developer guide.</p> <p>Development endpoints that are created without specifying a Glue version default to Glue 0.9.</p> <p>You can specify a version of Python support for development endpoints by using the <code>Arguments</code> parameter in the <code>CreateDevEndpoint</code> or <code>UpdateDevEndpoint</code> APIs. If no arguments are provided, the version defaults to Python 2.</p>"
},
"NumberOfWorkers":{
"shape":"NullableInteger",
"documentation":"<p>The number of workers of a defined <code>workerType</code> that are allocated to the development endpoint.</p> <p>The maximum number of workers you can define are 299 for <code>G.1X</code>, and 149 for <code>G.2X</code>. </p>"
@ -3566,6 +3554,10 @@
"shape":"WorkerType",
"documentation":"<p>The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.</p>"
},
"GlueVersion":{
"shape":"GlueVersionString",
"documentation":"<p>Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints. </p>"
},
"NumberOfWorkers":{
"shape":"NullableInteger",
"documentation":"<p>The number of workers of a defined <code>workerType</code> that are allocated to the development endpoint.</p>"
@ -3600,7 +3592,7 @@
},
"Arguments":{
"shape":"MapValue",
"documentation":"<p>The map of arguments used to configure this <code>DevEndpoint</code>.</p>"
"documentation":"<p>The map of arguments used to configure this <code>DevEndpoint</code>.</p> <p>Valid arguments are:</p> <ul> <li> <p> <code>\"--enable-glue-datacatalog\": \"\"</code> </p> </li> <li> <p> <code>\"GLUE_PYTHON_VERSION\": \"3\"</code> </p> </li> <li> <p> <code>\"GLUE_PYTHON_VERSION\": \"2\"</code> </p> </li> </ul> <p>You can specify a version of Python support for development endpoints by using the <code>Arguments</code> parameter in the <code>CreateDevEndpoint</code> or <code>UpdateDevEndpoint</code> APIs. If no arguments are provided, the version defaults to Python 2.</p>"
}
}
},
@ -4602,6 +4594,10 @@
"shape":"WorkerType",
"documentation":"<p>The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.</p> <ul> <li> <p>For the <code>Standard</code> worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.</p> </li> <li> <p>For the <code>G.1X</code> worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> <li> <p>For the <code>G.2X</code> worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.</p> </li> </ul> <p>Known issue: when a development endpoint is created with the <code>G.2X</code> <code>WorkerType</code> configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. </p>"
},
"GlueVersion":{
"shape":"GlueVersionString",
"documentation":"<p>Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints. </p> <p>For more information about the available AWS Glue versions and corresponding Spark and Python versions, see <a href=\"https://docs.aws.amazon.com/glue/latest/dg/add-job.html\">Glue version</a> in the developer guide.</p> <p>Development endpoints that are created without specifying a Glue version default to Glue 0.9.</p> <p>You can specify a version of Python support for development endpoints by using the <code>Arguments</code> parameter in the <code>CreateDevEndpoint</code> or <code>UpdateDevEndpoint</code> APIs. If no arguments are provided, the version defaults to Python 2.</p>"
},
"NumberOfWorkers":{
"shape":"NullableInteger",
"documentation":"<p>The number of workers of a defined <code>workerType</code> that are allocated to the development endpoint.</p> <p>The maximum number of workers you can define are 299 for <code>G.1X</code>, and 149 for <code>G.2X</code>. </p>"
@ -4656,7 +4652,7 @@
},
"Arguments":{
"shape":"MapValue",
"documentation":"<p>A map of arguments used to configure the <code>DevEndpoint</code>.</p> <p>Currently, only <code>\"--enable-glue-datacatalog\": \"\"</code> is supported as a valid argument.</p>"
"documentation":"<p>A map of arguments used to configure the <code>DevEndpoint</code>.</p> <p>Valid arguments are:</p> <ul> <li> <p> <code>\"--enable-glue-datacatalog\": \"\"</code> </p> </li> <li> <p> <code>\"GLUE_PYTHON_VERSION\": \"3\"</code> </p> </li> <li> <p> <code>\"GLUE_PYTHON_VERSION\": \"2\"</code> </p> </li> </ul> <p>You can specify a version of Python support for development endpoints by using the <code>Arguments</code> parameter in the <code>CreateDevEndpoint</code> or <code>UpdateDevEndpoint</code> APIs. If no arguments are provided, the version defaults to Python 2.</p>"
}
},
"documentation":"<p>A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.</p>"
@ -5298,37 +5294,6 @@
}
}
},
"GetJobBookmarksRequest":{
"type":"structure",
"required":["JobName"],
"members":{
"JobName":{
"shape":"JobName",
"documentation":"<p>The name of the job in question.</p>"
},
"MaxResults":{
"shape":"IntegerValue",
"documentation":"<p>The maximum size of the response.</p>"
},
"NextToken":{
"shape":"IntegerValue",
"documentation":"<p>A continuation token, if this is a continuation call.</p>"
}
}
},
"GetJobBookmarksResponse":{
"type":"structure",
"members":{
"JobBookmarkEntries":{
"shape":"JobBookmarkEntryList",
"documentation":"<p>A list of job bookmark entries that defines a point that a job can resume processing.</p>"
},
"NextToken":{
"shape":"IntegerValue",
"documentation":"<p>A continuation token, which has a value of 1 if all the entries are returned, or &gt; 1 if not all requested job runs have been returned.</p>"
}
}
},
"GetJobRequest":{
"type":"structure",
"required":["JobName"],
@ -6604,10 +6569,6 @@
},
"documentation":"<p>Defines a point that a job can resume processing.</p>"
},
"JobBookmarkEntryList":{
"type":"list",
"member":{"shape":"JobBookmarkEntry"}
},
"JobBookmarksEncryption":{
"type":"structure",
"members":{
@ -9316,7 +9277,7 @@
},
"AddArguments":{
"shape":"MapValue",
"documentation":"<p>The map of arguments to add the map of arguments used to configure the <code>DevEndpoint</code>.</p>"
"documentation":"<p>The map of arguments to add the map of arguments used to configure the <code>DevEndpoint</code>.</p> <p>Valid arguments are:</p> <ul> <li> <p> <code>\"--enable-glue-datacatalog\": \"\"</code> </p> </li> <li> <p> <code>\"GLUE_PYTHON_VERSION\": \"3\"</code> </p> </li> <li> <p> <code>\"GLUE_PYTHON_VERSION\": \"2\"</code> </p> </li> </ul> <p>You can specify a version of Python support for development endpoints by using the <code>Arguments</code> parameter in the <code>CreateDevEndpoint</code> or <code>UpdateDevEndpoint</code> APIs. If no arguments are provided, the version defaults to Python 2.</p>"
}
}
},

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

@ -1558,7 +1558,7 @@
"shape" : "BadRequestException",
"documentation" : "invalid request"
} ],
"documentation" : "Add resource tags to a Greengrass Resource. Valid resources are Group, Connector, Core, Device, Function, Logger, Subscription, and Resource Defintions, and also BulkDeploymentIds."
"documentation" : "Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'."
},
"UntagResource" : {
"name" : "UntagResource",
@ -2854,6 +2854,10 @@
"IotJobId" : {
"shape" : "__string",
"documentation" : "The IoT Job Id corresponding to this update."
},
"PlatformSoftwareVersion" : {
"shape" : "__string",
"documentation" : "The software version installed on the device or devices after the update."
}
}
},
@ -4097,11 +4101,11 @@
},
"Id" : {
"shape" : "__string",
"documentation" : "The ID of the group version."
"documentation" : "The ID of the group that the version is associated with."
},
"Version" : {
"shape" : "__string",
"documentation" : "The unique ID for the version of the group."
"documentation" : "The ID of the group version."
}
}
},
@ -5887,11 +5891,11 @@
},
"Id" : {
"shape" : "__string",
"documentation" : "The ID of the version."
"documentation" : "The ID of the parent definition that the version is associated with."
},
"Version" : {
"shape" : "__string",
"documentation" : "The unique ID of the version."
"documentation" : "The ID of the version."
}
},
"documentation" : "Information about a version."

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

@ -2598,7 +2598,7 @@
"documentation":"<p>The data type of the value (or values) specified in the <code>ContextKeyValues</code> parameter.</p>"
}
},
"documentation":"<p>Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the <code>Condition</code> elements of the input policies.</p> <p>This data type is used as an input parameter to <code> <a>SimulateCustomPolicy</a> </code> and <code> <a>SimulateCustomPolicy</a> </code>.</p>"
"documentation":"<p>Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the <code>Condition</code> elements of the input policies.</p> <p>This data type is used as an input parameter to <code> <a>SimulateCustomPolicy</a> </code> and <code> <a>SimulatePrincipalPolicy</a> </code>.</p>"
},
"ContextEntryListType":{
"type":"list",
@ -2861,7 +2861,7 @@
},
"AssumeRolePolicyDocument":{
"shape":"policyDocumentType",
"documentation":"<p>The trust relationship policy document that grants an entity permission to assume the role.</p> <p>In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</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> <p> Upon success, the response includes the same trust policy as a URL-encoded JSON string.</p>"
"documentation":"<p>The trust relationship policy document that grants an entity permission to assume the role.</p> <p>In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.</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> <p> Upon success, the response includes the same trust policy in JSON format.</p>"
},
"Description":{
"shape":"roleDescriptionType",

14
botocore/data/kinesisanalytics/2015-08-14/service-2.json
View file

@ -254,7 +254,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Retrieves the list of key-value tags assigned to the application.</p>"
"documentation":"<p>Retrieves the list of key-value tags assigned to the application. For more information, see <a href=\"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html\">Using Tagging</a>.</p>"
},
"StartApplication":{
"name":"StartApplication",
@ -303,7 +303,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.</p>"
"documentation":"<p>Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see <a href=\"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html\">Using Tagging</a>.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -320,7 +320,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Removes one or more tags from a Kinesis Analytics application.</p>"
"documentation":"<p>Removes one or more tags from a Kinesis Analytics application. For more information, see <a href=\"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html\">Using Tagging</a>.</p>"
},
"UpdateApplication":{
"name":"UpdateApplication",
@ -781,7 +781,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management Guide</i>.</p>"
"documentation":"<p>A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see <a href=\"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html\">Using Tagging</a>.</p>"
}
},
"documentation":"<p>TBD</p>"
@ -1176,7 +1176,7 @@
"members":{
"ResourceARNUpdate":{
"shape":"ResourceARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the new <a href=\"https://docs.aws.amazon.com/ambda/\">AWS Lambda</a> function that is used to preprocess the records in the stream.</p> <note> <p>To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see <a href=\"/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda\">Example ARNs: AWS Lambda</a> </p> </note>"
"documentation":"<p>The Amazon Resource Name (ARN) of the new <a href=\"https://docs.aws.amazon.com/lambda/\">AWS Lambda</a> function that is used to preprocess the records in the stream.</p> <note> <p>To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see <a href=\"/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-lambda\">Example ARNs: AWS Lambda</a> </p> </note>"
},
"RoleARNUpdate":{
"shape":"RoleARN",
@ -1984,7 +1984,7 @@
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see <a href=\"kinesis/latest/APIReference/API_GetRecords.html\">GetRecords</a> in the Amazon Kinesis Streams API Reference.</p>",
"documentation":"<p>Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see <a href=\"https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html\">GetRecords</a> in the Amazon Kinesis Streams API Reference.</p>",
"exception":true
},
"RoleARN":{
@ -2165,7 +2165,7 @@
"documentation":"<p>The value of the key-value tag. The value is optional.</p>"
}
},
"documentation":"<p>A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management Guide</i>.</p>"
"documentation":"<p>A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see <a href=\"https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html\">Using Tagging</a>.</p>"
},
"TagKey":{
"type":"string",

10
botocore/data/lambda/2015-03-31/service-2.json
View file

@ -1023,6 +1023,7 @@
"shape":"BatchSize",
"documentation":"<p>The maximum number of items to retrieve in a single batch.</p> <ul> <li> <p> <b>Amazon Kinesis</b> - Default 100. Max 10,000.</p> </li> <li> <p> <b>Amazon DynamoDB Streams</b> - Default 100. Max 1,000.</p> </li> <li> <p> <b>Amazon Simple Queue Service</b> - Default 10. Max 10.</p> </li> </ul>"
},
"MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"},
"StartingPosition":{
"shape":"EventSourcePosition",
"documentation":"<p>The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. <code>AT_TIMESTAMP</code> is only supported for Amazon Kinesis streams.</p>"
@ -1315,6 +1316,7 @@
"shape":"BatchSize",
"documentation":"<p>The maximum number of items to retrieve in a single batch.</p>"
},
"MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"},
"EventSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the event source.</p>"
@ -2417,6 +2419,11 @@
"max":10000,
"min":1
},
"MaximumBatchingWindowInSeconds":{
"type":"integer",
"max":300,
"min":0
},
"MemorySize":{
"type":"integer",
"max":3008,
@ -2980,7 +2987,8 @@
"BatchSize":{
"shape":"BatchSize",
"documentation":"<p>The maximum number of items to retrieve in a single batch.</p> <ul> <li> <p> <b>Amazon Kinesis</b> - Default 100. Max 10,000.</p> </li> <li> <p> <b>Amazon DynamoDB Streams</b> - Default 100. Max 1,000.</p> </li> <li> <p> <b>Amazon Simple Queue Service</b> - Default 10. Max 10.</p> </li> </ul>"
}
},
"MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}
}
},
"UpdateFunctionCodeRequest":{

502
botocore/data/lightsail/2016-11-28/service-2.json
View file

@ -48,7 +48,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.</p> <p>The <code>attach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.</p> <p>The <code>attach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"AttachInstancesToLoadBalancer":{
"name":"AttachInstancesToLoadBalancer",
@ -67,7 +67,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Attaches one or more Lightsail instances to a load balancer.</p> <p>After some time, the instances are attached to the load balancer and the health check status is available.</p> <p>The <code>attach instances to load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Attaches one or more Lightsail instances to a load balancer.</p> <p>After some time, the instances are attached to the load balancer and the health check status is available.</p> <p>The <code>attach instances to load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"AttachLoadBalancerTlsCertificate":{
"name":"AttachLoadBalancerTlsCertificate",
@ -86,7 +86,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the <code>AttachLoadBalancerTlsCertificate</code> operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.</p> <p>The <code>attach load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the <code>attach load balancer tls certificate</code> operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.</p> <p>The <code>attach load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"AttachStaticIp":{
"name":"AttachStaticIp",
@ -124,7 +124,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Closes the public ports on a specific Amazon Lightsail instance.</p> <p>The <code>close instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Closes the public ports on a specific Amazon Lightsail instance.</p> <p>The <code>close instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CopySnapshot":{
"name":"CopySnapshot",
@ -143,7 +143,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.</p>"
"documentation":"<p>Copies a manual instance or disk snapshot as another manual snapshot, or copies an automatic instance or disk snapshot as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.</p> <p>When copying a <i>manual snapshot</i>, be sure to define the <code>source region</code>, <code>source snapshot name</code>, and <code>target snapshot name</code> parameters.</p> <p>When copying an <i>automatic snapshot</i>, be sure to define the <code>source region</code>, <code>source resource name</code>, <code>target snapshot name</code>, and either the <code>restore date</code> or the <code>use latest restorable auto snapshot</code> parameters.</p> <note> <p>Database snapshots cannot be copied at this time.</p> </note>"
},
"CreateCloudFormationStack":{
"name":"CreateCloudFormationStack",
@ -181,7 +181,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail\">Regions and Availability Zones in Lightsail</a>.</p> <p>The <code>create disk</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>).</p> <p>The <code>create disk</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CreateDiskFromSnapshot":{
"name":"CreateDiskFromSnapshot",
@ -200,7 +200,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail\">Regions and Availability Zones in Lightsail</a>.</p> <p>The <code>create disk from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by diskSnapshotName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>).</p> <p>The <code>create disk from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>disk snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CreateDiskSnapshot":{
"name":"CreateDiskSnapshot",
@ -257,7 +257,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).</p> <p>The <code>create domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).</p> <p>The <code>create domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CreateInstanceSnapshot":{
"name":"CreateInstanceSnapshot",
@ -295,7 +295,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates one or more Amazon Lightsail virtual private servers, or <i>instances</i>. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.</p> <p>The <code>create instances</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Creates one or more Amazon Lightsail instances.</p> <p>The <code>create instances</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CreateInstancesFromSnapshot":{
"name":"CreateInstancesFromSnapshot",
@ -314,7 +314,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.</p> <p>The <code>create instances from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by instanceSnapshotName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Creates one or more new instances from a manual or automatic snapshot of an instance.</p> <p>The <code>create instances from snapshot</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>instance snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CreateKeyPair":{
"name":"CreateKeyPair",
@ -371,7 +371,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates a Lightsail load balancer TLS certificate.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>The <code>create load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Creates a Lightsail load balancer TLS certificate.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>The <code>create load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CreateRelationalDatabase":{
"name":"CreateRelationalDatabase",
@ -430,6 +430,24 @@
],
"documentation":"<p>Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.</p> <p>The <code>create relational database snapshot</code> operation supports tag-based access control via request tags. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteAutoSnapshot":{
"name":"DeleteAutoSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAutoSnapshotRequest"},
"output":{"shape":"DeleteAutoSnapshotResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes an automatic snapshot for an instance or disk.</p>"
},
"DeleteDisk":{
"name":"DeleteDisk",
"http":{
@ -447,7 +465,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes the specified block storage disk. The disk must be in the <code>available</code> state (not attached to a Lightsail instance).</p> <note> <p>The disk may remain in the <code>deleting</code> state for several minutes.</p> </note> <p>The <code>delete disk</code> operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes the specified block storage disk. The disk must be in the <code>available</code> state (not attached to a Lightsail instance).</p> <note> <p>The disk may remain in the <code>deleting</code> state for several minutes.</p> </note> <p>The <code>delete disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteDiskSnapshot":{
"name":"DeleteDiskSnapshot",
@ -466,7 +484,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes the specified disk snapshot.</p> <p>When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.</p> <p>The <code>delete disk snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by diskSnapshotName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes the specified disk snapshot.</p> <p>When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.</p> <p>The <code>delete disk snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteDomain":{
"name":"DeleteDomain",
@ -485,7 +503,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes the specified domain recordset and all of its domain records.</p> <p>The <code>delete domain</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes the specified domain recordset and all of its domain records.</p> <p>The <code>delete domain</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteDomainEntry":{
"name":"DeleteDomainEntry",
@ -504,7 +522,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes a specific domain entry.</p> <p>The <code>delete domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes a specific domain entry.</p> <p>The <code>delete domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteInstance":{
"name":"DeleteInstance",
@ -523,7 +541,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes a specific Amazon Lightsail virtual private server, or <i>instance</i>.</p> <p>The <code>delete instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes an Amazon Lightsail instance.</p> <p>The <code>delete instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteInstanceSnapshot":{
"name":"DeleteInstanceSnapshot",
@ -542,7 +560,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes a specific snapshot of a virtual private server (or <i>instance</i>).</p> <p>The <code>delete instance snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceSnapshotName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes a specific snapshot of a virtual private server (or <i>instance</i>).</p> <p>The <code>delete instance snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteKeyPair":{
"name":"DeleteKeyPair",
@ -561,7 +579,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes a specific SSH key pair.</p> <p>The <code>delete key pair</code> operation supports tag-based access control via resource tags applied to the resource identified by keyPairName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes a specific SSH key pair.</p> <p>The <code>delete key pair</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>key pair name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteKnownHostKeys":{
"name":"DeleteKnownHostKeys",
@ -599,7 +617,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.</p> <p>The <code>delete load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.</p> <p>The <code>delete load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteLoadBalancerTlsCertificate":{
"name":"DeleteLoadBalancerTlsCertificate",
@ -618,7 +636,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes an SSL/TLS certificate associated with a Lightsail load balancer.</p> <p>The <code>delete load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes an SSL/TLS certificate associated with a Lightsail load balancer.</p> <p>The <code>delete load balancer tls certificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DeleteRelationalDatabase":{
"name":"DeleteRelationalDatabase",
@ -675,7 +693,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.</p> <p>The <code>detach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by diskName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.</p> <p>The <code>detach disk</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>disk name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DetachInstancesFromLoadBalancer":{
"name":"DetachInstancesFromLoadBalancer",
@ -694,7 +712,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Detaches the specified instances from a Lightsail load balancer.</p> <p>This operation waits until the instances are no longer needed before they are detached from the load balancer.</p> <p>The <code>detach instances from load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Detaches the specified instances from a Lightsail load balancer.</p> <p>This operation waits until the instances are no longer needed before they are detached from the load balancer.</p> <p>The <code>detach instances from load balancer</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"DetachStaticIp":{
"name":"DetachStaticIp",
@ -715,6 +733,24 @@
],
"documentation":"<p>Detaches a static IP from the Amazon Lightsail instance to which it is attached.</p>"
},
"DisableAddOn":{
"name":"DisableAddOn",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableAddOnRequest"},
"output":{"shape":"DisableAddOnResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Disables an add-on for an Amazon Lightsail resource. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p>"
},
"DownloadDefaultKeyPair":{
"name":"DownloadDefaultKeyPair",
"http":{
@ -734,6 +770,24 @@
],
"documentation":"<p>Downloads the default SSH key pair from the user's account.</p>"
},
"EnableAddOn":{
"name":"EnableAddOn",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableAddOnRequest"},
"output":{"shape":"EnableAddOnResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p>"
},
"ExportSnapshot":{
"name":"ExportSnapshot",
"http":{
@ -751,7 +805,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the <code>create cloud formation stack</code> operation to create new Amazon EC2 instances.</p> <p>Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.</p> <p/> <p>The <code>export snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by sourceSnapshotName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p> <note> <p>Use the <code>get instance snapshots</code> or <code>get disk snapshots</code> operations to get a list of snapshots that you can export to Amazon EC2.</p> </note>"
"documentation":"<p>Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the <code>create cloud formation stack</code> operation to create new Amazon EC2 instances.</p> <p>Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.</p> <p/> <p>The <code>export snapshot</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>source snapshot name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p> <note> <p>Use the <code>get instance snapshots</code> or <code>get disk snapshots</code> operations to get a list of snapshots that you can export to Amazon EC2.</p> </note>"
},
"GetActiveNames":{
"name":"GetActiveNames",
@ -772,6 +826,24 @@
],
"documentation":"<p>Returns the names of all active (not deleted) resources.</p>"
},
"GetAutoSnapshots":{
"name":"GetAutoSnapshots",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAutoSnapshotsRequest"},
"output":{"shape":"GetAutoSnapshotsResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Returns the available automatic snapshots for the specified resource name. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p>"
},
"GetBlueprints":{
"name":"GetBlueprints",
"http":{
@ -789,7 +861,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Returns the list of available instance images, or <i>blueprints</i>. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.</p>"
"documentation":"<p>Returns the list of available instance images, or <i>blueprints</i>. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.</p> <note> <p>Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.</p> </note>"
},
"GetBundles":{
"name":"GetBundles",
@ -998,7 +1070,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Returns temporary SSH keys you can use to connect to a specific virtual private server, or <i>instance</i>.</p> <p>The <code>get instance access details</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Returns temporary SSH keys you can use to connect to a specific virtual private server, or <i>instance</i>.</p> <p>The <code>get instance access details</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"GetInstanceMetricData":{
"name":"GetInstanceMetricData",
@ -1435,7 +1507,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Returns the current, previous, or pending versions of the master user password for a Lightsail database.</p> <p>The <code>asdf</code> operation GetRelationalDatabaseMasterUserPassword supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.</p>"
"documentation":"<p>Returns the current, previous, or pending versions of the master user password for a Lightsail database.</p> <p>The <code>GetRelationalDatabaseMasterUserPassword</code> operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.</p>"
},
"GetRelationalDatabaseMetricData":{
"name":"GetRelationalDatabaseMetricData",
@ -1625,7 +1697,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Adds public ports to an Amazon Lightsail instance.</p> <p>The <code>open instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Adds public ports to an Amazon Lightsail instance.</p> <p>The <code>open instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"PeerVpc":{
"name":"PeerVpc",
@ -1663,7 +1735,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.</p> <p>The <code>put instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.</p> <p>The <code>put instance public ports</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"RebootInstance":{
"name":"RebootInstance",
@ -1682,7 +1754,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Restarts a specific instance.</p> <p>The <code>reboot instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Restarts a specific instance.</p> <p>The <code>reboot instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"RebootRelationalDatabase":{
"name":"RebootRelationalDatabase",
@ -1739,7 +1811,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the <code>reboot instance</code> operation.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip\">Lightsail Dev Guide</a>.</p> </note> <p>The <code>start instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the <code>reboot instance</code> operation.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip\">Lightsail Dev Guide</a>.</p> </note> <p>The <code>start instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"StartRelationalDatabase":{
"name":"StartRelationalDatabase",
@ -1777,7 +1849,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Stops a specific Amazon Lightsail instance that is currently running.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip\">Lightsail Dev Guide</a>.</p> </note> <p>The <code>stop instance</code> operation supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Stops a specific Amazon Lightsail instance that is currently running.</p> <note> <p>When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/lightsail-create-static-ip\">Lightsail Dev Guide</a>.</p> </note> <p>The <code>stop instance</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>instance name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"StopRelationalDatabase":{
"name":"StopRelationalDatabase",
@ -1815,7 +1887,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags\">Lightsail Dev Guide</a>.</p> <p>The <code>tag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags\">Lightsail Dev Guide</a>.</p> <p>The <code>tag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>resource name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"UnpeerVpc":{
"name":"UnpeerVpc",
@ -1853,7 +1925,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.</p> <p>The <code>untag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by resourceName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.</p> <p>The <code>untag resource</code> operation supports tag-based access control via request tags and resource tags applied to the resource identified by <code>resource name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"UpdateDomainEntry":{
"name":"UpdateDomainEntry",
@ -1872,7 +1944,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Updates a domain recordset after it is created.</p> <p>The <code>update domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by domainName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Updates a domain recordset after it is created.</p> <p>The <code>update domain entry</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>domain name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"UpdateLoadBalancerAttribute":{
"name":"UpdateLoadBalancerAttribute",
@ -1891,7 +1963,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Updates the specified attribute for a load balancer. You can only update one attribute at a time.</p> <p>The <code>update load balancer attribute</code> operation supports tag-based access control via resource tags applied to the resource identified by loadBalancerName. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Updates the specified attribute for a load balancer. You can only update one attribute at a time.</p> <p>The <code>update load balancer attribute</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"UpdateRelationalDatabase":{
"name":"UpdateRelationalDatabase",
@ -1962,6 +2034,55 @@
"documentation":"<p>Lightsail throws this exception when an account is still in the setup in progress state.</p>",
"exception":true
},
"AddOn":{
"type":"structure",
"members":{
"name":{
"shape":"string",
"documentation":"<p>The name of the add-on.</p>"
},
"status":{
"shape":"string",
"documentation":"<p>The status of the add-on.</p>"
},
"snapshotTimeOfDay":{
"shape":"TimeOfDay",
"documentation":"<p>The daily time when an automatic snapshot is created.</p> <p>The time shown is in <code>HH:00</code> format, and in Coordinated Universal Time (UTC).</p> <p>The snapshot is automatically created between the time shown and up to 45 minutes after.</p>"
},
"nextSnapshotTimeOfDay":{
"shape":"TimeOfDay",
"documentation":"<p>The next daily time an automatic snapshot will be created.</p> <p>The time shown is in <code>HH:00</code> format, and in Coordinated Universal Time (UTC).</p> <p>The snapshot is automatically created between the time shown and up to 45 minutes after.</p>"
}
},
"documentation":"<p>Describes an add-on that is enabled for an Amazon Lightsail resource.</p>"
},
"AddOnList":{
"type":"list",
"member":{"shape":"AddOn"}
},
"AddOnRequest":{
"type":"structure",
"required":["addOnType"],
"members":{
"addOnType":{
"shape":"AddOnType",
"documentation":"<p>The add-on type.</p>"
},
"autoSnapshotAddOnRequest":{
"shape":"AutoSnapshotAddOnRequest",
"documentation":"<p>An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.</p>"
}
},
"documentation":"<p>Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.</p> <note> <p>An additional cost may be associated with enabling add-ons. For more information, see the <a href=\"https://aws.amazon.com/lightsail/pricing/\">Lightsail pricing page</a>.</p> </note>"
},
"AddOnRequestList":{
"type":"list",
"member":{"shape":"AddOnRequest"}
},
"AddOnType":{
"type":"string",
"enum":["AutoSnapshot"]
},
"AllocateStaticIpRequest":{
"type":"structure",
"required":["staticIpName"],
@ -2090,11 +2211,78 @@
}
}
},
"AttachedDisk":{
"type":"structure",
"members":{
"path":{
"shape":"string",
"documentation":"<p>The path of the disk (e.g., <code>/dev/xvdf</code>).</p>"
},
"sizeInGb":{
"shape":"integer",
"documentation":"<p>The size of the disk in GB.</p>"
}
},
"documentation":"<p>Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.</p>"
},
"AttachedDiskList":{
"type":"list",
"member":{"shape":"AttachedDisk"}
},
"AttachedDiskMap":{
"type":"map",
"key":{"shape":"ResourceName"},
"value":{"shape":"DiskMapList"}
},
"AutoSnapshotAddOnRequest":{
"type":"structure",
"members":{
"snapshotTimeOfDay":{
"shape":"TimeOfDay",
"documentation":"<p>The daily time when an automatic snapshot will be created.</p> <p>Constraints:</p> <ul> <li> <p>Must be in <code>HH:00</code> format, and in an hourly increment.</p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>The snapshot will be automatically created between the time specified and up to 45 minutes after.</p> </li> </ul>"
}
},
"documentation":"<p>Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.</p> <p>When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:</p> <ul> <li> <p>If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.</p> </li> <li> <p>If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.</p> </li> <li> <p>If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.</p> </li> <li> <p>If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.</p> </li> </ul>"
},
"AutoSnapshotDate":{
"type":"string",
"pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
"AutoSnapshotDetails":{
"type":"structure",
"members":{
"date":{
"shape":"string",
"documentation":"<p>The date of the automatic snapshot in <code>YYYY-MM-DD</code> format.</p>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The timestamp when the automatic snapshot was created.</p>"
},
"status":{
"shape":"AutoSnapshotStatus",
"documentation":"<p>The status of the automatic snapshot.</p>"
},
"fromAttachedDisks":{
"shape":"AttachedDiskList",
"documentation":"<p>An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.</p>"
}
},
"documentation":"<p>Describes an automatic snapshot.</p>"
},
"AutoSnapshotDetailsList":{
"type":"list",
"member":{"shape":"AutoSnapshotDetails"}
},
"AutoSnapshotStatus":{
"type":"string",
"enum":[
"Success",
"Failed",
"InProgress",
"NotFound"
]
},
"AvailabilityZone":{
"type":"structure",
"members":{
@ -2330,14 +2518,25 @@
"CopySnapshotRequest":{
"type":"structure",
"required":[
"sourceSnapshotName",
"targetSnapshotName",
"sourceRegion"
],
"members":{
"sourceSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source instance or disk snapshot to be copied.</p>"
"documentation":"<p>The name of the source instance or disk snapshot to be copied.</p> <note> <p>Define this parameter only when copying a manual snapshot as another manual snapshot.</p> </note>"
},
"sourceResourceName":{
"shape":"string",
"documentation":"<p>The name of the source resource from which the automatic snapshot was created.</p> <note> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
},
"restoreDate":{
"shape":"string",
"documentation":"<p>The date of the automatic snapshot to copy for the new manual snapshot.</p> <p>Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> </ul> <note> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
},
"useLatestRestorableAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
},
"targetSnapshotName":{
"shape":"ResourceName",
@ -2345,7 +2544,7 @@
},
"sourceRegion":{
"shape":"RegionName",
"documentation":"<p>The AWS Region where the source snapshot is located.</p>"
"documentation":"<p>The AWS Region where the source manual or automatic snapshot is located.</p>"
}
}
},
@ -2381,7 +2580,6 @@
"type":"structure",
"required":[
"diskName",
"diskSnapshotName",
"availabilityZone",
"sizeInGb"
],
@ -2392,7 +2590,7 @@
},
"diskSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the new storage disk.</p>"
"documentation":"<p>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the new storage disk.</p> <p>This parameter cannot be defined together with the <code>source disk name</code> parameter. The <code>disk snapshot name</code> and <code>source disk name</code> parameters are mutually exclusive.</p>"
},
"availabilityZone":{
"shape":"NonEmptyString",
@ -2405,6 +2603,22 @@
"tags":{
"shape":"TagList",
"documentation":"<p>The tag keys and optional values to add to the resource during create.</p> <p>To tag a resource after it has been created, see the <code>tag resource</code> operation.</p>"
},
"addOns":{
"shape":"AddOnRequestList",
"documentation":"<p>An array of objects that represent the add-ons to enable for the new disk.</p>"
},
"sourceDiskName":{
"shape":"string",
"documentation":"<p>The name of the source disk from which the source automatic snapshot was created.</p> <p>This parameter cannot be defined together with the <code>disk snapshot name</code> parameter. The <code>source disk name</code> and <code>disk snapshot name</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
},
"restoreDate":{
"shape":"string",
"documentation":"<p>The date of the automatic snapshot to use for the new disk.</p> <p>Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> </ul> <note> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
},
"useLatestRestorableAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
}
}
},
@ -2431,7 +2645,7 @@
},
"availabilityZone":{
"shape":"NonEmptyString",
"documentation":"<p>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.</p> <p>Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.</p>"
"documentation":"<p>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.</p> <p>Use the <code>get regions</code> operation to list the Availability Zones where Lightsail is currently available.</p>"
},
"sizeInGb":{
"shape":"integer",
@ -2440,6 +2654,10 @@
"tags":{
"shape":"TagList",
"documentation":"<p>The tag keys and optional values to add to the resource during create.</p> <p>To tag a resource after it has been created, see the <code>tag resource</code> operation.</p>"
},
"addOns":{
"shape":"AddOnRequestList",
"documentation":"<p>An array of objects that represent the add-ons to enable for the new disk.</p>"
}
}
},
@ -2567,7 +2785,6 @@
"required":[
"instanceNames",
"availabilityZone",
"instanceSnapshotName",
"bundleId"
],
"members":{
@ -2585,7 +2802,7 @@
},
"instanceSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.</p>"
"documentation":"<p>The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.</p> <p>This parameter cannot be defined together with the <code>source instance name</code> parameter. The <code>instance snapshot name</code> and <code>source instance name</code> parameters are mutually exclusive.</p>"
},
"bundleId":{
"shape":"NonEmptyString",
@ -2602,6 +2819,22 @@
"tags":{
"shape":"TagList",
"documentation":"<p>The tag keys and optional values to add to the resource during create.</p> <p>To tag a resource after it has been created, see the <code>tag resource</code> operation.</p>"
},
"addOns":{
"shape":"AddOnRequestList",
"documentation":"<p>An array of objects representing the add-ons to enable for the new instance.</p>"
},
"sourceInstanceName":{
"shape":"string",
"documentation":"<p>The name of the source instance from which the source automatic snapshot was created.</p> <p>This parameter cannot be defined together with the <code>instance snapshot name</code> parameter. The <code>source instance name</code> and <code>instance snapshot name</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
},
"restoreDate":{
"shape":"string",
"documentation":"<p>The date of the automatic snapshot to use for the new instance.</p> <p>Use the <code>get auto snapshots</code> operation to identify the dates of the available automatic snapshots.</p> <p>Constraints:</p> <ul> <li> <p>Must be specified in <code>YYYY-MM-DD</code> format.</p> </li> <li> <p>This parameter cannot be defined together with the <code>use latest restorable auto snapshot</code> parameter. The <code>restore date</code> and <code>use latest restorable auto snapshot</code> parameters are mutually exclusive.</p> </li> </ul> <note> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
},
"useLatestRestorableAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p> <p>This parameter cannot be defined together with the <code>restore date</code> parameter. The <code>use latest restorable auto snapshot</code> and <code>restore date</code> parameters are mutually exclusive.</p> <note> <p>Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots\">Lightsail Dev Guide</a>.</p> </note>"
}
}
},
@ -2638,7 +2871,7 @@
},
"blueprintId":{
"shape":"NonEmptyString",
"documentation":"<p>The ID for a virtual private server image (e.g., <code>app_wordpress_4_4</code> or <code>app_lamp_7_0</code>). Use the get blueprints operation to return a list of available images (or <i>blueprints</i>).</p>"
"documentation":"<p>The ID for a virtual private server image (e.g., <code>app_wordpress_4_4</code> or <code>app_lamp_7_0</code>). Use the <code>get blueprints</code> operation to return a list of available images (or <i>blueprints</i>).</p> <note> <p>Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.</p> </note>"
},
"bundleId":{
"shape":"NonEmptyString",
@ -2655,6 +2888,10 @@
"tags":{
"shape":"TagList",
"documentation":"<p>The tag keys and optional values to add to the resource during create.</p> <p>To tag a resource after it has been created, see the <code>tag resource</code> operation.</p>"
},
"addOns":{
"shape":"AddOnRequestList",
"documentation":"<p>An array of objects representing the add-ons to enable for the new instance.</p>"
}
}
},
@ -2817,7 +3054,7 @@
},
"restoreTime":{
"shape":"IsoDate",
"documentation":"<p>The date and time to restore your database from.</p> <p>Constraints:</p> <ul> <li> <p>Must be before the latest restorable time for the database.</p> </li> <li> <p>Cannot be specified if the <code>use latest restorable time</code> parameter is <code>true</code>.</p> </li> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the restore time.</p> </li> </ul>"
"documentation":"<p>The date and time to restore your database from.</p> <p>Constraints:</p> <ul> <li> <p>Must be before the latest restorable time for the database.</p> </li> <li> <p>Cannot be specified if the <code>use latest restorable time</code> parameter is <code>true</code>.</p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the restore time.</p> </li> </ul>"
},
"useLatestRestorableTime":{
"shape":"boolean",
@ -2878,11 +3115,11 @@
},
"preferredBackupWindow":{
"shape":"string",
"documentation":"<p>The daily time range during which automated backups are created for your new database if automated backups are enabled.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow\">Working With Backups</a> guide in the Amazon Relational Database Service (Amazon RDS) documentation.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>hh24:mi-hh24:mi</code> format.</p> <p>Example: <code>16:00-16:30</code> </p> </li> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
"documentation":"<p>The daily time range during which automated backups are created for your new database if automated backups are enabled.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow\">Working With Backups</a> guide in the Amazon Relational Database Service (Amazon RDS) documentation.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>hh24:mi-hh24:mi</code> format.</p> <p>Example: <code>16:00-16:30</code> </p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
},
"preferredMaintenanceWindow":{
"shape":"string",
"documentation":"<p>The weekly time range during which system maintenance can occur on your new database.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>ddd:hh24:mi-ddd:hh24:mi</code> format.</p> </li> <li> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Example: <code>Tue:17:00-Tue:17:30</code> </p> </li> </ul>"
"documentation":"<p>The weekly time range during which system maintenance can occur on your new database.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>ddd:hh24:mi-ddd:hh24:mi</code> format.</p> </li> <li> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Example: <code>Tue:17:00-Tue:17:30</code> </p> </li> </ul>"
},
"publiclyAccessible":{
"shape":"boolean",
@ -2933,6 +3170,32 @@
}
}
},
"DeleteAutoSnapshotRequest":{
"type":"structure",
"required":[
"resourceName",
"date"
],
"members":{
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource from which to delete the automatic snapshot.</p>"
},
"date":{
"shape":"AutoSnapshotDate",
"documentation":"<p>The date of the automatic snapshot to delete in <code>YYYY-MM-DD</code> format.</p> <p>Use the <code>get auto snapshots</code> operation to get the available automatic snapshots for a resource.</p>"
}
}
},
"DeleteAutoSnapshotResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An array of objects that describe the result of your request.</p>"
}
}
},
"DeleteDiskRequest":{
"type":"structure",
"required":["diskName"],
@ -2940,6 +3203,10 @@
"diskName":{
"shape":"ResourceName",
"documentation":"<p>The unique name of the disk you want to delete (e.g., <code>my-disk</code>).</p>"
},
"forceDeleteAddOns":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to delete the enabled add-ons for the disk.</p>"
}
}
},
@ -2948,7 +3215,7 @@
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An object describing the API operations.</p>"
"documentation":"<p>An array of objects that describe the result of your request.</p>"
}
}
},
@ -3023,6 +3290,10 @@
"instanceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the instance to delete.</p>"
},
"forceDeleteAddOns":{
"shape":"boolean",
"documentation":"<p>A Boolean value to indicate whether to delete the enabled add-ons for the disk.</p>"
}
}
},
@ -3265,6 +3536,32 @@
}
}
},
"DisableAddOnRequest":{
"type":"structure",
"required":[
"addOnType",
"resourceName"
],
"members":{
"addOnType":{
"shape":"AddOnType",
"documentation":"<p>The add-on type to disable.</p>"
},
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource from which to disable the add-on.</p>"
}
}
},
"DisableAddOnResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An array of objects that describe the result of your request.</p>"
}
}
},
"Disk":{
"type":"structure",
"members":{
@ -3296,6 +3593,10 @@
"shape":"TagList",
"documentation":"<p>The tag keys and optional values for the resource. For more information about tags in Lightsail, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags\">Lightsail Dev Guide</a>.</p>"
},
"addOns":{
"shape":"AddOnList",
"documentation":"<p>An array of objects representing the add-ons enabled on the disk.</p>"
},
"sizeInGb":{
"shape":"integer",
"documentation":"<p>The size of the disk in GB.</p>"
@ -3335,7 +3636,7 @@
"deprecated":true
}
},
"documentation":"<p>Describes a system disk or an block storage disk.</p>"
"documentation":"<p>Describes a system disk or a block storage disk.</p>"
},
"DiskInfo":{
"type":"structure",
@ -3443,6 +3744,10 @@
"fromInstanceArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.</p>"
},
"isFromAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value indicating whether the snapshot was created from an automatic snapshot.</p>"
}
},
"documentation":"<p>Describes a block storage disk snapshot.</p>"
@ -3587,6 +3892,32 @@
}
}
},
"EnableAddOnRequest":{
"type":"structure",
"required":[
"resourceName",
"addOnRequest"
],
"members":{
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource for which to enable or modify the add-on.</p>"
},
"addOnRequest":{
"shape":"AddOnRequest",
"documentation":"<p>An array of strings representing the add-on to enable or modify.</p>"
}
}
},
"EnableAddOnResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An array of objects that describe the result of your request.</p>"
}
}
},
"ExportSnapshotRecord":{
"type":"structure",
"members":{
@ -3715,6 +4046,33 @@
}
}
},
"GetAutoSnapshotsRequest":{
"type":"structure",
"required":["resourceName"],
"members":{
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource from which to get automatic snapshot information.</p>"
}
}
},
"GetAutoSnapshotsResult":{
"type":"structure",
"members":{
"resourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the source resource for the automatic snapshots.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type (e.g., <code>Instance</code> or <code>Disk</code>).</p>"
},
"autoSnapshots":{
"shape":"AutoSnapshotDetailsList",
"documentation":"<p>An array of objects that describe the automatic snapshots that are available for the specified source resource.asdf</p>"
}
}
},
"GetBlueprintsRequest":{
"type":"structure",
"members":{
@ -4475,15 +4833,15 @@
},
"startTime":{
"shape":"IsoDate",
"documentation":"<p>The start of the time interval from which to get log events.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p> </li> </ul>"
"documentation":"<p>The start of the time interval from which to get log events.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p> </li> </ul>"
},
"endTime":{
"shape":"IsoDate",
"documentation":"<p>The end of the time interval from which to get log events.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p> </li> </ul>"
"documentation":"<p>The end of the time interval from which to get log events.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p> </li> </ul>"
},
"startFromHead":{
"shape":"boolean",
"documentation":"<p>Parameter to specify if the log should start from head or tail. If <code>true</code> is specified, the log event starts from the head of the log. If <code>false</code> is specified, the log event starts from the tail of the log.</p> <p>Default: <code>false</code> </p>"
"documentation":"<p>Parameter to specify if the log should start from head or tail. If <code>true</code> is specified, the log event starts from the head of the log. If <code>false</code> is specified, the log event starts from the tail of the log.</p> <note> <p>For PostgreSQL, the default value of <code>false</code> is the only option available.</p> </note>"
},
"pageToken":{
"shape":"string",
@ -4580,11 +4938,11 @@
},
"startTime":{
"shape":"IsoDate",
"documentation":"<p>The start of the time interval from which to get metric data.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p> </li> </ul>"
"documentation":"<p>The start of the time interval from which to get metric data.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the start time.</p> </li> </ul>"
},
"endTime":{
"shape":"IsoDate",
"documentation":"<p>The end of the time interval from which to get metric data.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p> </li> </ul>"
"documentation":"<p>The end of the time interval from which to get metric data.</p> <p>Constraints:</p> <ul> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Specified in the Unix time format.</p> <p>For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input <code>1538424000</code> as the end time.</p> </li> </ul>"
},
"unit":{
"shape":"MetricUnit",
@ -4866,6 +5224,10 @@
"shape":"NonEmptyString",
"documentation":"<p>The bundle for the instance (e.g., <code>micro_1_0</code>).</p>"
},
"addOns":{
"shape":"AddOnList",
"documentation":"<p>An array of objects representing the add-ons enabled on the instance.</p>"
},
"isStaticIp":{
"shape":"boolean",
"documentation":"<p>A Boolean value indicating whether this instance has a static IP assigned to it.</p>"
@ -5224,12 +5586,16 @@
"shape":"string",
"documentation":"<p>The bundle ID from which you created the snapshot (e.g., <code>micro_1_0</code>).</p>"
},
"isFromAutoSnapshot":{
"shape":"boolean",
"documentation":"<p>A Boolean value indicating whether the snapshot was created from an automatic snapshot.</p>"
},
"sizeInGb":{
"shape":"integer",
"documentation":"<p>The size in GB of the SSD.</p>"
}
},
"documentation":"<p>Describes the snapshot of the virtual private server, or <i>instance</i>.</p>"
"documentation":"<p>Describes an instance snapshot.</p>"
},
"InstanceSnapshotInfo":{
"type":"structure",
@ -5904,7 +6270,7 @@
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The region and Availability Zone.</p>"
"documentation":"<p>The AWS Region and Availability Zone.</p>"
},
"isTerminal":{
"shape":"boolean",
@ -6009,7 +6375,9 @@
"UpdateRelationalDatabaseParameters",
"StartRelationalDatabase",
"RebootRelationalDatabase",
"StopRelationalDatabase"
"StopRelationalDatabase",
"EnableAddOn",
"DisableAddOn"
]
},
"PasswordData":{
@ -6661,6 +7029,10 @@
}
}
},
"ResourceArn":{
"type":"string",
"pattern":"^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$"
},
"ResourceLocation":{
"type":"structure",
"members":{
@ -6891,6 +7263,10 @@
"shape":"ResourceName",
"documentation":"<p>The name of the resource to which you are adding tags.</p>"
},
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to which you want to add a tag.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The tag key and optional value.</p>"
@ -6907,6 +7283,10 @@
}
},
"TagValue":{"type":"string"},
"TimeOfDay":{
"type":"string",
"pattern":"^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$"
},
"UnauthenticatedException":{
"type":"structure",
"members":{
@ -6943,6 +7323,10 @@
"shape":"ResourceName",
"documentation":"<p>The name of the resource from which you are removing a tag.</p>"
},
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.</p>"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys to delete from the specified resource.</p>"
@ -7059,11 +7443,11 @@
},
"preferredBackupWindow":{
"shape":"string",
"documentation":"<p>The daily time range during which automated backups are created for your database if automated backups are enabled.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>hh24:mi-hh24:mi</code> format.</p> <p>Example: <code>16:00-16:30</code> </p> </li> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
"documentation":"<p>The daily time range during which automated backups are created for your database if automated backups are enabled.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>hh24:mi-hh24:mi</code> format.</p> <p>Example: <code>16:00-16:30</code> </p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Must not conflict with the preferred maintenance window.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> </ul>"
},
"preferredMaintenanceWindow":{
"shape":"string",
"documentation":"<p>The weekly time range during which system maintenance can occur on your database.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>ddd:hh24:mi-ddd:hh24:mi</code> format.</p> </li> <li> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> <li> <p>Specified in Universal Coordinated Time (UTC).</p> </li> <li> <p>Example: <code>Tue:17:00-Tue:17:30</code> </p> </li> </ul>"
"documentation":"<p>The weekly time range during which system maintenance can occur on your database.</p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.</p> <p>Constraints:</p> <ul> <li> <p>Must be in the <code>ddd:hh24:mi-ddd:hh24:mi</code> format.</p> </li> <li> <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.</p> </li> <li> <p>Must be at least 30 minutes.</p> </li> <li> <p>Specified in Coordinated Universal Time (UTC).</p> </li> <li> <p>Example: <code>Tue:17:00-Tue:17:30</code> </p> </li> </ul>"
},
"enableBackupRetention":{
"shape":"boolean",

4
botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json
View file

@ -63,6 +63,8 @@
"daily_business_canceled_product_subscribers",
"monthly_revenue_billing_and_revenue_data",
"monthly_revenue_annual_subscriptions",
"monthly_revenue_field_demonstration_usage",
"monthly_revenue_flexible_payment_schedule",
"disbursed_amount_by_product",
"disbursed_amount_by_product_with_uncollected_funds",
"disbursed_amount_by_instance_hours",
@ -97,7 +99,7 @@
"members":{
"dataSetType":{
"shape":"DataSetType",
"documentation":"<p>The desired data set type.</p> <p> <ul> <li> <strong>customer_subscriber_hourly_monthly_subscriptions</strong> <p>From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>customer_subscriber_annual_subscriptions</strong> <p>From 2014-07-21 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>daily_business_usage_by_instance_type</strong> <p>From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>daily_business_fees</strong> <p>From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>daily_business_free_trial_conversions</strong> <p>From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>daily_business_new_instances</strong> <p>From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>daily_business_new_product_subscribers</strong> <p>From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>daily_business_canceled_product_subscribers</strong> <p>From 2015-01-26 to present: Available daily by 5:00 PM Pacific Time.</p> </li> <li> <strong>monthly_revenue_billing_and_revenue_data</strong> <p>From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior.</p> <p>From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior.</p> </li> <li> <strong>monthly_revenue_annual_subscriptions</strong> <p>From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior.</p> <p>From 2017-07 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>disbursed_amount_by_product</strong> <p>From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.</p> </li> <li> <strong>disbursed_amount_by_product_with_uncollected_funds</strong> <p>From 2012-04-19 to 2015-01-25: Available every 30 days by 5:00 PM Pacific Time.</p> <p>From 2015-01-26 to present: This data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.</p> </li> <li> <strong>disbursed_amount_by_instance_hours</strong> <p>From 2012-09-04 to present: Available every 30 days by 5:00 PM Pacific Time.</p> </li> <li> <strong>disbursed_amount_by_customer_geo</strong> <p>From 2012-04-19 to present: Available every 30 days by 5:00 PM Pacific Time.</p> </li> <li> <strong>disbursed_amount_by_age_of_uncollected_funds</strong> <p>From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.</p> </li> <li> <strong>disbursed_amount_by_age_of_disbursed_funds</strong> <p>From 2015-01-26 to present: Available every 30 days by 5:00 PM Pacific Time.</p> </li> <li> <strong>customer_profile_by_industry</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>customer_profile_by_revenue</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>customer_profile_by_geography</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 5:00 PM Pacific Time.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>sales_compensation_billed_revenue</strong> <p>From 2016-12 to 2017-06: Available monthly on the 4th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from two months prior, and up-front software charges (e.g. annual) from one month prior.</p> <p>From 2017-06 to present: Available monthly on the 15th day of the month by 5:00pm Pacific Time. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>us_sales_and_use_tax_records</strong> <p>From 2017-02-15 to present: Available monthly on the 15th day of the month by 5:00 PM Pacific Time.</p> </li> </ul> </p>"
"documentation":"<p>The desired data set type.</p> <p> <ul> <li> <strong>customer_subscriber_hourly_monthly_subscriptions</strong> <p>From 2014-07-21 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>customer_subscriber_annual_subscriptions</strong> <p>From 2014-07-21 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_usage_by_instance_type</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_fees</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_free_trial_conversions</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_new_instances</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_new_product_subscribers</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>daily_business_canceled_product_subscribers</strong> <p>From 2015-01-26 to present: Available daily by 24:00 UTC.</p> </li> <li> <strong>monthly_revenue_billing_and_revenue_data</strong> <p>From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from two months prior.</p> <p>From 2017-07 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.</p> </li> <li> <strong>monthly_revenue_annual_subscriptions</strong> <p>From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.</p> <p>From 2017-07 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>monthly_revenue_field_demonstration_usage</strong> <p>From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> <li> <strong>monthly_revenue_flexible_payment_schedule</strong> <p>From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_product</strong> <p>From 2015-01-26 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_product_with_uncollected_funds</strong> <p>From 2012-04-19 to 2015-01-25: Available every 30 days by 24:00 UTC.</p> <p>From 2015-01-26 to present: This data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.</p> </li> <li> <strong>disbursed_amount_by_instance_hours</strong> <p>From 2012-09-04 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_customer_geo</strong> <p>From 2012-04-19 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_uncollected_funds</strong> <p>From 2015-01-26 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>disbursed_amount_by_age_of_disbursed_funds</strong> <p>From 2015-01-26 to present: Available every 30 days by 24:00 UTC.</p> </li> <li> <strong>customer_profile_by_industry</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>customer_profile_by_revenue</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>customer_profile_by_geography</strong> <p>From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.</p> <p>From 2017-06-30 to present: This data set is no longer available.</p> </li> <li> <strong>sales_compensation_billed_revenue</strong> <p>From 2016-12 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from two months prior, and up-front software charges (e.g. annual) from one month prior.</p> <p>From 2017-06 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.</p> </li> <li> <strong>us_sales_and_use_tax_records</strong> <p>From 2017-02-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.</p> </li> </ul> </p>"
},
"dataSetPublicationDate":{
"shape":"DataSetPublicationDate",

46
botocore/data/mediaconnect/2018-11-14/service-2.json
View file

@ -780,7 +780,7 @@
"SmoothingLatency": {
"shape": "__integer",
"locationName": "smoothingLatency",
"documentation": "The smoothing latency in milliseconds for RTP and RTP-FEC streams."
"documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams."
},
"StreamId": {
"shape": "__string",
@ -994,6 +994,11 @@
"Entitlement": {
"type": "structure",
"members": {
"DataTransferSubscriberFeePercent": {
"shape": "__integer",
"locationName": "dataTransferSubscriberFeePercent",
"documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber."
},
"Description": {
"shape": "__string",
"locationName": "description",
@ -1107,6 +1112,11 @@
"GrantEntitlementRequest": {
"type": "structure",
"members": {
"DataTransferSubscriberFeePercent": {
"shape": "__integer",
"locationName": "dataTransferSubscriberFeePercent",
"documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber."
},
"Description": {
"shape": "__string",
"locationName": "description",
@ -1303,6 +1313,11 @@
"ListedEntitlement": {
"type": "structure",
"members": {
"DataTransferSubscriberFeePercent": {
"shape": "__integer",
"locationName": "dataTransferSubscriberFeePercent",
"documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber."
},
"EntitlementArn": {
"shape": "__string",
"locationName": "entitlementArn",
@ -1404,6 +1419,11 @@
"Output": {
"type": "structure",
"members": {
"DataTransferSubscriberFeePercent": {
"shape": "__integer",
"locationName": "dataTransferSubscriberFeePercent",
"documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber."
},
"Description": {
"shape": "__string",
"locationName": "description",
@ -1462,7 +1482,8 @@
"zixi-push",
"rtp-fec",
"rtp",
"zixi-pull"
"zixi-pull",
"rist"
]
},
"RemoveFlowOutputRequest": {
@ -1595,12 +1616,12 @@
"MaxBitrate": {
"shape": "__integer",
"locationName": "maxBitrate",
"documentation": "The smoothing max bitrate for RTP and RTP-FEC streams."
"documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams."
},
"MaxLatency": {
"shape": "__integer",
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds for Zixi-based streams."
"documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."
},
"Name": {
"shape": "__string",
@ -1628,6 +1649,11 @@
"Source": {
"type": "structure",
"members": {
"DataTransferSubscriberFeePercent": {
"shape": "__integer",
"locationName": "dataTransferSubscriberFeePercent",
"documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber."
},
"Decryption": {
"shape": "Encryption",
"locationName": "decryption",
@ -1807,12 +1833,12 @@
"MaxBitrate": {
"shape": "__integer",
"locationName": "maxBitrate",
"documentation": "The smoothing max bitrate for RTP and RTP-FEC streams."
"documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams."
},
"MaxLatency": {
"shape": "__integer",
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds for Zixi-based streams."
"documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."
},
"Protocol": {
"shape": "Protocol",
@ -1827,7 +1853,7 @@
"SmoothingLatency": {
"shape": "__integer",
"locationName": "smoothingLatency",
"documentation": "The smoothing latency in milliseconds for RTP and RTP-FEC streams."
"documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams."
},
"StreamId": {
"shape": "__string",
@ -2021,7 +2047,7 @@
"SmoothingLatency": {
"shape": "__integer",
"locationName": "smoothingLatency",
"documentation": "The smoothing latency in milliseconds for RTP and RTP-FEC streams."
"documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams."
},
"StreamId": {
"shape": "__string",
@ -2081,12 +2107,12 @@
"MaxBitrate": {
"shape": "__integer",
"locationName": "maxBitrate",
"documentation": "The smoothing max bitrate for RTP and RTP-FEC streams."
"documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams."
},
"MaxLatency": {
"shape": "__integer",
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds for Zixi-based streams."
"documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."
},
"Protocol": {
"shape": "Protocol",

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

@ -1286,9 +1286,9 @@
"documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track."
},
"Channels": {
"shape": "__integerMin1Max2",
"shape": "__integerMin1Max64",
"locationName": "channels",
"documentation": "Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2."
"documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64."
},
"SampleRate": {
"shape": "__integerMin8000Max192000",
@ -1298,17 +1298,43 @@
},
"documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF."
},
"AncillaryConvert608To708": {
"type": "string",
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.",
"enum": [
"UPCONVERT",
"DISABLED"
]
},
"AncillarySourceSettings": {
"type": "structure",
"members": {
"Convert608To708": {
"shape": "AncillaryConvert608To708",
"locationName": "convert608To708",
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708."
},
"SourceAncillaryChannelNumber": {
"shape": "__integerMin1Max4",
"locationName": "sourceAncillaryChannelNumber",
"documentation": "Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough."
},
"TerminateCaptions": {
"shape": "AncillaryTerminateCaptions",
"locationName": "terminateCaptions",
"documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting."
}
},
"documentation": "Settings for ancillary captions source."
},
"AncillaryTerminateCaptions": {
"type": "string",
"documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.",
"enum": [
"END_OF_INPUT",
"DISABLED"
]
},
"AntiAlias": {
"type": "string",
"documentation": "The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.",
@ -1891,7 +1917,7 @@
"DestinationType": {
"shape": "CaptionDestinationType",
"locationName": "destinationType",
"documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20)."
"documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20)."
},
"DvbSubDestinationSettings": {
"shape": "DvbSubDestinationSettings",
@ -1903,6 +1929,11 @@
"locationName": "embeddedDestinationSettings",
"documentation": "Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number."
},
"ImscDestinationSettings": {
"shape": "ImscDestinationSettings",
"locationName": "imscDestinationSettings",
"documentation": "Settings specific to IMSC caption outputs."
},
"SccDestinationSettings": {
"shape": "SccDestinationSettings",
"locationName": "sccDestinationSettings",
@ -1923,12 +1954,13 @@
},
"CaptionDestinationType": {
"type": "string",
"documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).",
"documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).",
"enum": [
"BURN_IN",
"DVB_SUB",
"EMBEDDED",
"EMBEDDED_PLUS_SCTE20",
"IMSC",
"SCTE20_PLUS_EMBEDDED",
"SCC",
"SRT",
@ -1954,7 +1986,7 @@
"SourceSettings": {
"shape": "CaptionSourceSettings",
"locationName": "sourceSettings",
"documentation": "Source settings (SourceSettings) contains the group of settings for captions in the input."
"documentation": "If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings."
}
},
"documentation": "Set up captions in your outputs by first selecting them from your input here."
@ -1980,7 +2012,7 @@
"FileSourceSettings": {
"shape": "FileSourceSettings",
"locationName": "fileSourceSettings",
"documentation": "Settings for File-based Captions in Source"
"documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings."
},
"SourceType": {
"shape": "CaptionSourceType",
@ -1995,10 +2027,10 @@
"TrackSourceSettings": {
"shape": "TrackSourceSettings",
"locationName": "trackSourceSettings",
"documentation": "Settings specific to caption sources that are specfied by track number. Sources include IMSC in IMF."
"documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings."
}
},
"documentation": "Source settings (SourceSettings) contains the group of settings for captions in the input."
"documentation": "If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings."
},
"CaptionSourceType": {
"type": "string",
@ -2056,7 +2088,7 @@
"EncryptionMethod": {
"shape": "CmafEncryptionType",
"locationName": "encryptionMethod",
"documentation": "For DRM with CMAF, the encryption type is always sample AES."
"documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR)."
},
"InitializationVectorInManifest": {
"shape": "CmafInitializationVectorInManifest",
@ -2066,7 +2098,7 @@
"SpekeKeyProvider": {
"shape": "SpekeKeyProviderCmaf",
"locationName": "spekeKeyProvider",
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is CMAF. If your output group type is HLS, MS Smooth, or DASH, use the SpekeKeyProvider settings instead."
"documentation": "If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead."
},
"StaticKeyProvider": {
"shape": "StaticKeyProvider",
@ -2083,9 +2115,10 @@
},
"CmafEncryptionType": {
"type": "string",
"documentation": "For DRM with CMAF, the encryption type is always sample AES.",
"documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR).",
"enum": [
"SAMPLE_AES"
"SAMPLE_AES",
"AES_CTR"
]
},
"CmafGroupSettings": {
@ -2429,6 +2462,11 @@
"locationName": "settings",
"documentation": "JobSettings contains all the transcode settings for a job."
},
"SimulateReservedQueue": {
"shape": "SimulateReservedQueue",
"locationName": "simulateReservedQueue",
"documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default."
},
"StatusUpdateInterval": {
"shape": "StatusUpdateInterval",
"locationName": "statusUpdateInterval",
@ -2622,7 +2660,7 @@
"SpekeKeyProvider": {
"shape": "SpekeKeyProvider",
"locationName": "spekeKeyProvider",
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
"documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
}
},
"documentation": "Specifies DRM settings for DASH outputs."
@ -3527,7 +3565,7 @@
},
"EmbeddedConvert608To708": {
"type": "string",
"documentation": "When set to UPCONVERT, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.",
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.",
"enum": [
"UPCONVERT",
"DISABLED"
@ -3539,12 +3577,12 @@
"Destination608ChannelNumber": {
"shape": "__integerMin1Max4",
"locationName": "destination608ChannelNumber",
"documentation": "Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, pick CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded."
"documentation": "Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded."
},
"Destination708ServiceNumber": {
"shape": "__integerMin1Max6",
"locationName": "destination708ServiceNumber",
"documentation": "Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded."
"documentation": "Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded."
}
},
"documentation": "Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number."
@ -3555,7 +3593,7 @@
"Convert608To708": {
"shape": "EmbeddedConvert608To708",
"locationName": "convert608To708",
"documentation": "When set to UPCONVERT, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded."
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708."
},
"Source608ChannelNumber": {
"shape": "__integerMin1Max4",
@ -3566,10 +3604,23 @@
"shape": "__integerMin1Max1",
"locationName": "source608TrackNumber",
"documentation": "Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'."
},
"TerminateCaptions": {
"shape": "EmbeddedTerminateCaptions",
"locationName": "terminateCaptions",
"documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting."
}
},
"documentation": "Settings for embedded captions Source"
},
"EmbeddedTerminateCaptions": {
"type": "string",
"documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.",
"enum": [
"END_OF_INPUT",
"DISABLED"
]
},
"Endpoint": {
"type": "structure",
"members": {
@ -3670,7 +3721,7 @@
},
"FileSourceConvert608To708": {
"type": "string",
"documentation": "If set to UPCONVERT, 608 caption data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded.",
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.",
"enum": [
"UPCONVERT",
"DISABLED"
@ -3682,12 +3733,12 @@
"Convert608To708": {
"shape": "FileSourceConvert608To708",
"locationName": "convert608To708",
"documentation": "If set to UPCONVERT, 608 caption data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded."
"documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708."
},
"SourceFile": {
"shape": "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTSmiSMI",
"shape": "__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI",
"locationName": "sourceFile",
"documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', and 'smi'."
"documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'."
},
"TimeDelta": {
"shape": "__integerMinNegative2147483648Max2147483647",
@ -3695,7 +3746,7 @@
"documentation": "Specifies a time delta in seconds to offset the captions from the source file."
}
},
"documentation": "Settings for File-based Captions in Source"
"documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings."
},
"FontScript": {
"type": "string",
@ -4888,7 +4939,7 @@
"SpekeKeyProvider": {
"shape": "SpekeKeyProvider",
"locationName": "spekeKeyProvider",
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
"documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
},
"StaticKeyProvider": {
"shape": "StaticKeyProvider",
@ -5189,6 +5240,25 @@
},
"documentation": "Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. This setting is disabled by default."
},
"ImscDestinationSettings": {
"type": "structure",
"members": {
"StylePassthrough": {
"shape": "ImscStylePassthrough",
"locationName": "stylePassthrough",
"documentation": "Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions."
}
},
"documentation": "Settings specific to IMSC caption outputs."
},
"ImscStylePassthrough": {
"type": "string",
"documentation": "Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.",
"enum": [
"ENABLED",
"DISABLED"
]
},
"Input": {
"type": "structure",
"members": {
@ -5275,7 +5345,12 @@
"TimecodeSource": {
"shape": "InputTimecodeSource",
"locationName": "timecodeSource",
"documentation": "Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes."
"documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode."
},
"TimecodeStart": {
"shape": "__stringMin11Max11Pattern01D20305D205D",
"locationName": "timecodeStart",
"documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode."
},
"VideoSelector": {
"shape": "VideoSelector",
@ -5442,7 +5517,12 @@
"TimecodeSource": {
"shape": "InputTimecodeSource",
"locationName": "timecodeSource",
"documentation": "Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes."
"documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode."
},
"TimecodeStart": {
"shape": "__stringMin11Max11Pattern01D20305D205D",
"locationName": "timecodeStart",
"documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode."
},
"VideoSelector": {
"shape": "VideoSelector",
@ -5454,7 +5534,7 @@
},
"InputTimecodeSource": {
"type": "string",
"documentation": "Timecode source under input settings (InputTimecodeSource) only affects the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Use this setting to specify whether the service counts frames by timecodes embedded in the video (EMBEDDED) or by starting the first frame at zero (ZEROBASED). In both cases, the timecode format is HH:MM:SS:FF or HH:MM:SS;FF, where FF is the frame number. Only set this to EMBEDDED if your source video has embedded timecodes.",
"documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.",
"enum": [
"EMBEDDED",
"ZEROBASED",
@ -5619,6 +5699,11 @@
"locationName": "settings",
"documentation": "JobSettings contains all the transcode settings for a job."
},
"SimulateReservedQueue": {
"shape": "SimulateReservedQueue",
"locationName": "simulateReservedQueue",
"documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default."
},
"Status": {
"shape": "JobStatus",
"locationName": "status",
@ -7226,7 +7311,7 @@
"SpekeKeyProvider": {
"shape": "SpekeKeyProvider",
"locationName": "spekeKeyProvider",
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
"documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
}
},
"documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider."
@ -7379,7 +7464,7 @@
"Strength": {
"shape": "__integerMin0Max16",
"locationName": "strength",
"documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering. Recommended Range: * [0 .. 2] for complexity reduction with minimal sharpness loss * [2 .. 8] for complexity reduction with image preservation * [8 .. 16] for noise reduction. Reduce noise combined high complexity reduction"
"documentation": "Specify the strength of the noise reducing filter on this output. Higher values produce stronger filtering. We recommend the following value ranges, depending on the result that you want: * 0-2 for complexity reduction with minimal sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for a high level of complexity reduction"
}
},
"documentation": "Noise reducer filter settings for temporal filter."
@ -7914,14 +7999,14 @@
"documentation": "Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification)."
},
"ChannelsIn": {
"shape": "__integerMin1Max16",
"shape": "__integerMin1Max64",
"locationName": "channelsIn",
"documentation": "Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different."
},
"ChannelsOut": {
"shape": "__integerMin1Max8",
"shape": "__integerMin1Max64",
"locationName": "channelsOut",
"documentation": "Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8"
"documentation": "Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.)"
}
},
"documentation": "Use Manual audio remixing (RemixSettings) to adjust audio levels for each audio channel in each output of your job. With audio remixing, you can output more or fewer audio channels than your input audio source provides."
@ -8093,6 +8178,14 @@
},
"documentation": "Settings for SCC caption output."
},
"SimulateReservedQueue": {
"type": "string",
"documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.",
"enum": [
"DISABLED",
"ENABLED"
]
},
"SpekeKeyProvider": {
"type": "structure",
"members": {
@ -8117,7 +8210,7 @@
"documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content."
}
},
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
"documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."
},
"SpekeKeyProviderCmaf": {
"type": "structure",
@ -8148,7 +8241,7 @@
"documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content."
}
},
"documentation": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is CMAF. If your output group type is HLS, MS Smooth, or DASH, use the SpekeKeyProvider settings instead."
"documentation": "If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead."
},
"StaticKeyProvider": {
"type": "structure",
@ -8393,7 +8486,7 @@
"documentation": "Use this setting to select a single captions track from a source. Track numbers correspond to the order in the captions source file. For IMF sources, track numbering is based on the order that the captions appear in the CPL. For example, use 1 to select the captions asset that is listed first in the CPL. To include more than one captions track in your job outputs, create multiple input captions selectors. Specify one track per selector."
}
},
"documentation": "Settings specific to caption sources that are specfied by track number. Sources include IMSC in IMF."
"documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings."
},
"TtmlDestinationSettings": {
"type": "structure",
@ -8668,7 +8761,7 @@
"documentation": "Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output."
},
"Height": {
"shape": "__integerMin32Max2160",
"shape": "__integerMin32Max4096",
"locationName": "height",
"documentation": "Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height."
},
@ -8818,9 +8911,9 @@
"documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track."
},
"Channels": {
"shape": "__integerMin1Max8",
"shape": "__integerMin1Max64",
"locationName": "channels",
"documentation": "Set Channels to specify the number of channels in this output audio track. With WAV, valid values 1, 2, 4, and 8. In the console, these values are Mono, Stereo, 4-Channel, and 8-Channel, respectively."
"documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64."
},
"Format": {
"shape": "WavFormat",
@ -9047,11 +9140,6 @@
"min": 1,
"max": 1001
},
"__integerMin1Max16": {
"type": "integer",
"min": 1,
"max": 16
},
"__integerMin1Max17895697": {
"type": "integer",
"min": 1,
@ -9097,10 +9185,10 @@
"min": 1,
"max": 6
},
"__integerMin1Max8": {
"__integerMin1Max64": {
"type": "integer",
"min": 1,
"max": 8
"max": 64
},
"__integerMin24Max60000": {
"type": "integer",
@ -9132,11 +9220,6 @@
"min": 32000,
"max": 48000
},
"__integerMin32Max2160": {
"type": "integer",
"min": 32,
"max": 2160
},
"__integerMin32Max4096": {
"type": "integer",
"min": 32,
@ -9470,10 +9553,10 @@
"min": 14,
"pattern": "^(s3:\\/\\/)(.*?)\\.(bmp|BMP|png|PNG|tga|TGA)$"
},
"__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTSmiSMI": {
"__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI": {
"type": "string",
"min": 14,
"pattern": "^(s3:\\/\\/)(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|smi|SMI)$"
"pattern": "^(s3:\\/\\/)(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI)$"
},
"__stringMin16Max24PatternAZaZ0922AZaZ0916": {
"type": "string",

421
botocore/data/medialive/2017-10-14/service-2.json
View file

@ -1894,7 +1894,7 @@
"AudioOnlyImage": {
"shape": "InputLocation",
"locationName": "audioOnlyImage",
"documentation": "For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by {image file size} * {segment count} * {user count.}."
"documentation": "Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth.\n\nThe image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the \"ID3 tag version 2.4.0 - Native Frames\" standard."
},
"AudioTrackType": {
"shape": "AudioOnlyHlsTrackType",
@ -2733,6 +2733,12 @@
},
"documentation": "Placeholder documentation for ChannelSummary"
},
"ColorSpacePassthroughSettings": {
"type": "structure",
"members": {
},
"documentation": "Passthrough applies no color space conversion to the output"
},
"ConflictException": {
"type": "structure",
"members": {
@ -4646,6 +4652,24 @@
"INSERT"
]
},
"H264ColorSpaceSettings": {
"type": "structure",
"members": {
"ColorSpacePassthroughSettings": {
"shape": "ColorSpacePassthroughSettings",
"locationName": "colorSpacePassthroughSettings"
},
"Rec601Settings": {
"shape": "Rec601Settings",
"locationName": "rec601Settings"
},
"Rec709Settings": {
"shape": "Rec709Settings",
"locationName": "rec709Settings"
}
},
"documentation": "H264 Color Space Settings"
},
"H264EntropyEncoding": {
"type": "string",
"documentation": "H264 Entropy Encoding",
@ -4743,6 +4767,7 @@
"documentation": "H264 Rate Control Mode",
"enum": [
"CBR",
"MULTIPLEX",
"QVBR",
"VBR"
]
@ -4789,13 +4814,18 @@
"BufSize": {
"shape": "__integerMin0",
"locationName": "bufSize",
"documentation": "Size of buffer (HRD buffer model) in bits/second."
"documentation": "Size of buffer (HRD buffer model) in bits."
},
"ColorMetadata": {
"shape": "H264ColorMetadata",
"locationName": "colorMetadata",
"documentation": "Includes colorspace metadata in the output."
},
"ColorSpaceSettings": {
"shape": "H264ColorSpaceSettings",
"locationName": "colorSpaceSettings",
"documentation": "Color Space settings"
},
"EntropyEncoding": {
"shape": "H264EntropyEncoding",
"locationName": "entropyEncoding",
@ -4864,7 +4894,7 @@
"MaxBitrate": {
"shape": "__integerMin1000",
"locationName": "maxBitrate",
"documentation": "For QVBR: See the tooltip for Quality level \n\nFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video."
"documentation": "For QVBR: See the tooltip for Quality level\n\nFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video."
},
"MinIInterval": {
"shape": "__integerMin0Max30",
@ -4904,7 +4934,7 @@
"RateControlMode": {
"shape": "H264RateControlMode",
"locationName": "rateControlMode",
"documentation": "Rate control mode. \n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nVBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR\nif you want to maintain a specific average bitrate over the duration of the channel.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates."
"documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nVBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR\nif you want to maintain a specific average bitrate over the duration of the channel.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates."
},
"ScanType": {
"shape": "H264ScanType",
@ -4994,6 +5024,314 @@
"PIC_TIMING_SEI"
]
},
"H265AdaptiveQuantization": {
"type": "string",
"documentation": "H265 Adaptive Quantization",
"enum": [
"HIGH",
"HIGHER",
"LOW",
"MAX",
"MEDIUM",
"OFF"
]
},
"H265AlternativeTransferFunction": {
"type": "string",
"documentation": "H265 Alternative Transfer Function",
"enum": [
"INSERT",
"OMIT"
]
},
"H265ColorMetadata": {
"type": "string",
"documentation": "H265 Color Metadata",
"enum": [
"IGNORE",
"INSERT"
]
},
"H265ColorSpaceSettings": {
"type": "structure",
"members": {
"ColorSpacePassthroughSettings": {
"shape": "ColorSpacePassthroughSettings",
"locationName": "colorSpacePassthroughSettings"
},
"Hdr10Settings": {
"shape": "Hdr10Settings",
"locationName": "hdr10Settings"
},
"Rec601Settings": {
"shape": "Rec601Settings",
"locationName": "rec601Settings"
},
"Rec709Settings": {
"shape": "Rec709Settings",
"locationName": "rec709Settings"
}
},
"documentation": "H265 Color Space Settings"
},
"H265FlickerAq": {
"type": "string",
"documentation": "H265 Flicker Aq",
"enum": [
"DISABLED",
"ENABLED"
]
},
"H265GopSizeUnits": {
"type": "string",
"documentation": "H265 Gop Size Units",
"enum": [
"FRAMES",
"SECONDS"
]
},
"H265Level": {
"type": "string",
"documentation": "H265 Level",
"enum": [
"H265_LEVEL_1",
"H265_LEVEL_2",
"H265_LEVEL_2_1",
"H265_LEVEL_3",
"H265_LEVEL_3_1",
"H265_LEVEL_4",
"H265_LEVEL_4_1",
"H265_LEVEL_5",
"H265_LEVEL_5_1",
"H265_LEVEL_5_2",
"H265_LEVEL_6",
"H265_LEVEL_6_1",
"H265_LEVEL_6_2",
"H265_LEVEL_AUTO"
]
},
"H265LookAheadRateControl": {
"type": "string",
"documentation": "H265 Look Ahead Rate Control",
"enum": [
"HIGH",
"LOW",
"MEDIUM"
]
},
"H265Profile": {
"type": "string",
"documentation": "H265 Profile",
"enum": [
"MAIN",
"MAIN_10BIT"
]
},
"H265RateControlMode": {
"type": "string",
"documentation": "H265 Rate Control Mode",
"enum": [
"CBR",
"QVBR"
]
},
"H265ScanType": {
"type": "string",
"documentation": "H265 Scan Type",
"enum": [
"PROGRESSIVE"
]
},
"H265SceneChangeDetect": {
"type": "string",
"documentation": "H265 Scene Change Detect",
"enum": [
"DISABLED",
"ENABLED"
]
},
"H265Settings": {
"type": "structure",
"members": {
"AdaptiveQuantization": {
"shape": "H265AdaptiveQuantization",
"locationName": "adaptiveQuantization",
"documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality."
},
"AfdSignaling": {
"shape": "AfdSignaling",
"locationName": "afdSignaling",
"documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter."
},
"AlternativeTransferFunction": {
"shape": "H265AlternativeTransferFunction",
"locationName": "alternativeTransferFunction",
"documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays."
},
"Bitrate": {
"shape": "__integerMin100000Max40000000",
"locationName": "bitrate",
"documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000."
},
"BufSize": {
"shape": "__integerMin100000Max80000000",
"locationName": "bufSize",
"documentation": "Size of buffer (HRD buffer model) in bits."
},
"ColorMetadata": {
"shape": "H265ColorMetadata",
"locationName": "colorMetadata",
"documentation": "Includes colorspace metadata in the output."
},
"ColorSpaceSettings": {
"shape": "H265ColorSpaceSettings",
"locationName": "colorSpaceSettings",
"documentation": "Color Space settings"
},
"FixedAfd": {
"shape": "FixedAfd",
"locationName": "fixedAfd",
"documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'."
},
"FlickerAq": {
"shape": "H265FlickerAq",
"locationName": "flickerAq",
"documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames."
},
"FramerateDenominator": {
"shape": "__integerMin1Max3003",
"locationName": "framerateDenominator",
"documentation": "Framerate denominator."
},
"FramerateNumerator": {
"shape": "__integerMin1",
"locationName": "framerateNumerator",
"documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps."
},
"GopClosedCadence": {
"shape": "__integerMin0",
"locationName": "gopClosedCadence",
"documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting."
},
"GopSize": {
"shape": "__doubleMin1",
"locationName": "gopSize",
"documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero."
},
"GopSizeUnits": {
"shape": "H265GopSizeUnits",
"locationName": "gopSizeUnits",
"documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time."
},
"Level": {
"shape": "H265Level",
"locationName": "level",
"documentation": "H.265 Level."
},
"LookAheadRateControl": {
"shape": "H265LookAheadRateControl",
"locationName": "lookAheadRateControl",
"documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content."
},
"MaxBitrate": {
"shape": "__integerMin100000Max40000000",
"locationName": "maxBitrate",
"documentation": "For QVBR: See the tooltip for Quality level"
},
"MinIInterval": {
"shape": "__integerMin0Max30",
"locationName": "minIInterval",
"documentation": "Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1"
},
"ParDenominator": {
"shape": "__integerMin1",
"locationName": "parDenominator",
"documentation": "Pixel Aspect Ratio denominator."
},
"ParNumerator": {
"shape": "__integerMin1",
"locationName": "parNumerator",
"documentation": "Pixel Aspect Ratio numerator."
},
"Profile": {
"shape": "H265Profile",
"locationName": "profile",
"documentation": "H.265 Profile."
},
"QvbrQualityLevel": {
"shape": "__integerMin1Max10",
"locationName": "qvbrQualityLevel",
"documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M"
},
"RateControlMode": {
"shape": "H265RateControlMode",
"locationName": "rateControlMode",
"documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates."
},
"ScanType": {
"shape": "H265ScanType",
"locationName": "scanType",
"documentation": "Sets the scan type of the output to progressive or top-field-first interlaced."
},
"SceneChangeDetect": {
"shape": "H265SceneChangeDetect",
"locationName": "sceneChangeDetect",
"documentation": "Scene change detection."
},
"Slices": {
"shape": "__integerMin1Max16",
"locationName": "slices",
"documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution."
},
"Tier": {
"shape": "H265Tier",
"locationName": "tier",
"documentation": "H.265 Tier."
},
"TimecodeInsertion": {
"shape": "H265TimecodeInsertionBehavior",
"locationName": "timecodeInsertion",
"documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config"
}
},
"documentation": "H265 Settings",
"required": [
"FramerateNumerator",
"FramerateDenominator"
]
},
"H265Tier": {
"type": "string",
"documentation": "H265 Tier",
"enum": [
"HIGH",
"MAIN"
]
},
"H265TimecodeInsertionBehavior": {
"type": "string",
"documentation": "H265 Timecode Insertion Behavior",
"enum": [
"DISABLED",
"PIC_TIMING_SEI"
]
},
"Hdr10Settings": {
"type": "structure",
"members": {
"MaxCll": {
"shape": "__integerMin0Max32768",
"locationName": "maxCll",
"documentation": "Maximum Content Light Level\nAn integer metadata value defining the maximum light level, in nits,\nof any single pixel within an encoded HDR video stream or file."
},
"MaxFall": {
"shape": "__integerMin0Max32768",
"locationName": "maxFall",
"documentation": "Maximum Frame Average Light Level\nAn integer metadata value defining the maximum average light level, in nits,\nfor any single frame within an encoded HDR video stream or file."
}
},
"documentation": "Hdr10 Settings"
},
"HlsAdMarkers": {
"type": "string",
"documentation": "Hls Ad Markers",
@ -7352,9 +7690,22 @@
"Destination"
]
},
"MsSmoothH265PackagingType": {
"type": "string",
"documentation": "Ms Smooth H265 Packaging Type",
"enum": [
"HEV1",
"HVC1"
]
},
"MsSmoothOutputSettings": {
"type": "structure",
"members": {
"H265PackagingType": {
"shape": "MsSmoothH265PackagingType",
"locationName": "h265PackagingType",
"documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1."
},
"NameModifier": {
"shape": "__string",
"locationName": "nameModifier",
@ -7815,6 +8166,18 @@
},
"documentation": "PurchaseOffering response"
},
"Rec601Settings": {
"type": "structure",
"members": {
},
"documentation": "Rec601 Settings"
},
"Rec709Settings": {
"type": "structure",
"members": {
},
"documentation": "Rec709 Settings"
},
"RemixSettings": {
"type": "structure",
"members": {
@ -8622,26 +8985,6 @@
"WEB_DELIVERY_ALLOWED"
]
},
"ServiceDescriptor": {
"type": "structure",
"members": {
"ProviderName": {
"shape": "__stringMax256",
"locationName": "providerName",
"documentation": "Name of provider"
},
"ServiceName": {
"shape": "__stringMax256",
"locationName": "serviceName",
"documentation": "Name of service"
}
},
"documentation": "Program configuration.",
"required": [
"ProviderName",
"ServiceName"
]
},
"SmoothGroupAudioOnlyTimecodeControl": {
"type": "string",
"documentation": "Smooth Group Audio Only Timecode Control",
@ -9609,6 +9952,10 @@
"H264Settings": {
"shape": "H264Settings",
"locationName": "h264Settings"
},
"H265Settings": {
"shape": "H265Settings",
"locationName": "h265Settings"
}
},
"documentation": "Video Codec Settings"
@ -9680,7 +10027,7 @@
"ColorSpace": {
"shape": "VideoSelectorColorSpace",
"locationName": "colorSpace",
"documentation": "Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed."
"documentation": "Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed."
},
"ColorSpaceUsage": {
"shape": "VideoSelectorColorSpaceUsage",
@ -9849,6 +10196,12 @@
"max": 30,
"documentation": "Placeholder documentation for __integerMin0Max30"
},
"__integerMin0Max32768": {
"type": "integer",
"min": 0,
"max": 32768,
"documentation": "Placeholder documentation for __integerMin0Max32768"
},
"__integerMin0Max3600": {
"type": "integer",
"min": 0,
@ -9907,6 +10260,18 @@
"max": 100000000,
"documentation": "Placeholder documentation for __integerMin100000Max100000000"
},
"__integerMin100000Max40000000": {
"type": "integer",
"min": 100000,
"max": 40000000,
"documentation": "Placeholder documentation for __integerMin100000Max40000000"
},
"__integerMin100000Max80000000": {
"type": "integer",
"min": 100000,
"max": 80000000,
"documentation": "Placeholder documentation for __integerMin100000Max80000000"
},
"__integerMin1000Max30000": {
"type": "integer",
"min": 1000,
@ -9937,6 +10302,12 @@
"max": 20,
"documentation": "Placeholder documentation for __integerMin1Max20"
},
"__integerMin1Max3003": {
"type": "integer",
"min": 1,
"max": 3003,
"documentation": "Placeholder documentation for __integerMin1Max3003"
},
"__integerMin1Max31": {
"type": "integer",
"min": 1,

5
botocore/data/mediapackage-vod/2018-11-07/service-2.json
View file

@ -1087,6 +1087,11 @@
"HlsEncryption": {
"documentation": "An HTTP Live Streaming (HLS) encryption configuration.",
"members": {
"ConstantInitializationVector": {
"documentation": "A constant initialization vector for encryption (optional).\nWhen not specified the initialization vector will be periodically rotated.\n",
"locationName": "constantInitializationVector",
"shape": "__string"
},
"EncryptionMethod": {
"documentation": "The encryption method to use.",
"locationName": "encryptionMethod",

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

@ -1029,7 +1029,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -1132,7 +1132,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -1614,6 +1614,16 @@
"locationName" : "pendingEngineVersion",
"documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"PendingSecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "pendingSecurityGroups",
"documentation" : "The list of pending security groups to authorize connections to brokers."
},
"PendingHostInstanceType" : {
"shape" : "__string",
"locationName" : "pendingHostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"PubliclyAccessible" : {
"shape" : "__boolean",
"locationName" : "publiclyAccessible",
@ -1622,7 +1632,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -1737,6 +1747,16 @@
"locationName" : "pendingEngineVersion",
"documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"PendingSecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "pendingSecurityGroups",
"documentation" : "The list of pending security groups to authorize connections to brokers."
},
"PendingHostInstanceType" : {
"shape" : "__string",
"locationName" : "pendingHostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"PubliclyAccessible" : {
"shape" : "__boolean",
"locationName" : "publiclyAccessible",
@ -1745,7 +1765,7 @@
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers."
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
},
"SubnetIds" : {
"shape" : "__listOf__string",
@ -2520,10 +2540,20 @@
"locationName" : "engineVersion",
"documentation" : "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "Enables Amazon CloudWatch logging for brokers."
},
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
}
},
"documentation" : "Updates the broker using the specified properties."
@ -2551,10 +2581,20 @@
"locationName" : "engineVersion",
"documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "The list of information about logs to be enabled for the specified broker."
},
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
}
},
"documentation" : "Returns information about the updated broker."
@ -2583,10 +2623,20 @@
"locationName" : "engineVersion",
"documentation" : "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "Enables Amazon CloudWatch logging for brokers."
},
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
}
},
"documentation" : "Updates the broker using the specified properties.",
@ -2615,10 +2665,20 @@
"locationName" : "engineVersion",
"documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html"
},
"HostInstanceType" : {
"shape" : "__string",
"locationName" : "hostInstanceType",
"documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types"
},
"Logs" : {
"shape" : "Logs",
"locationName" : "logs",
"documentation" : "The list of information about logs to be enabled for the specified broker."
},
"SecurityGroups" : {
"shape" : "__listOf__string",
"locationName" : "securityGroups",
"documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers."
}
}
},
@ -3002,4 +3062,4 @@
}
},
"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."
}
}

32
botocore/data/organizations/2016-11-28/service-2.json
View file

@ -56,7 +56,7 @@
{"shape":"TargetNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy:</p> <ul> <li> <p> <b>Service control policy (SCP)</b> - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:</p> <ul> <li> <p>If you attach an SCP to a root, it affects all accounts in the organization</p> </li> <li> <p>If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs</p> </li> <li> <p>If you attach the policy directly to an account, it affects only that account</p> </li> </ul> <p>SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child can't grant a permission that the paren't hasn't already granted. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They can't use A or B because the child OU filtered them out. They also can't use F and G because the parent OU filtered them out. They can't be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.</p> <p>AWS Organizations attaches a default SCP named <code>\"FullAWSAccess</code> to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.</p> <p>For more information about how AWS Organizations policies permissions work, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html\">Using Service Control Policies</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul> <p>This operation can be called only from the organization's master account.</p>"
"documentation":"<p>Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy:</p> <ul> <li> <p> <b>Service control policy (SCP)</b> - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:</p> <ul> <li> <p>If you attach an SCP to a root, it affects all accounts in the organization.</p> </li> <li> <p>If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.</p> </li> <li> <p>If you attach the policy directly to an account, it affects only that account.</p> </li> </ul> <p>SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). You can attach one SCP to a higher level root or OU, and a different SCP to a child OU or to an account. The child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child can't grant a permission that the parent hasn't already granted. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They can't use A or B because the child OU filtered them out. They also can't use F and G because the parent OU filtered them out. They can't be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.</p> <p>AWS Organizations attaches a default SCP named <code>\"FullAWSAccess</code> to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.</p> <p>For more information about how AWS Organizations policies permissions work, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html\">Using Service Control Policies</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul> <p>This operation can be called only from the organization's master account.</p>"
},
"CancelHandshake":{
"name":"CancelHandshake",
@ -97,7 +97,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"UnsupportedAPIEndpointException"}
],
"documentation":"<p>Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because <code>CreateAccount</code> operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:</p> <ul> <li> <p>Use the <code>OperationId</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> </li> <li> <p>Check the AWS CloudTrail log for the <code>CreateAccountResult</code> event. For information on using AWS CloudTrail with AWS Organizations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html\">Monitoring the Activity in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul> <p/> <p>The user who calls the API to create an account must have the <code>organizations:CreateAccount</code> permission. If you enabled all features in the organization, AWS Organizations will create the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs\">AWS Organizations and Service-Linked Roles</a> in the <i>AWS Organizations User Guide</i>.</p> <p>AWS Organizations preconfigures the new member account with a role (named <code>OrganizationAccountAccessRole</code> by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.</p> <p>This operation can be called only from the organization's master account.</p> <p>For more information about creating accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an AWS Account in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> <important> <ul> <li> <p>When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is <i>not</i> automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization as a member account</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>If you get an exception that indicates that you exceeded your account limits for the organization, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>Using <code>CreateAccount</code> to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html\">Closing an AWS Account</a> in the <i>AWS Organizations User Guide</i>.</p> </li> </ul> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note>"
"documentation":"<p>Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because <code>CreateAccount</code> operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:</p> <ul> <li> <p>Use the <code>OperationId</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> </li> <li> <p>Check the AWS CloudTrail log for the <code>CreateAccountResult</code> event. For information on using AWS CloudTrail with AWS Organizations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_monitoring.html\">Monitoring the Activity in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul> <p/> <p>The user who calls the API to create an account must have the <code>organizations:CreateAccount</code> permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named <code>AWSServiceRoleForOrganizations</code>. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html#orgs_integrate_services-using_slrs\">AWS Organizations and Service-Linked Roles</a> in the <i>AWS Organizations User Guide</i>.</p> <p>AWS Organizations preconfigures the new member account with a role (named <code>OrganizationAccountAccessRole</code> by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.</p> <p>This operation can be called only from the organization's master account.</p> <p>For more information about creating accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an AWS Account in Your Organization</a> in the <i>AWS Organizations User Guide.</i> </p> <important> <ul> <li> <p>When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is <i>not</i> automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization as a member account</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>If you get an exception that indicates that you exceeded your account limits for the organization, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </li> <li> <p>Using <code>CreateAccount</code> to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_close.html\">Closing an AWS Account</a> in the <i>AWS Organizations User Guide</i>.</p> </li> </ul> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note>"
},
"CreateGovCloudAccount":{
"name":"CreateGovCloudAccount",
@ -384,7 +384,7 @@
{"shape":"TargetNotFoundException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.</p> <p> <b>Note:</b> Every root, OU, and account must have at least one SCP attached. If you want to replace the default <code>FullAWSAccess</code> policy with one that limits the permissions that can be delegated, you must attach the replacement policy before you can remove the default one. This is the authorization strategy of <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_whitelist\">whitelisting</a>. If you instead attach a second SCP and leave the <code>FullAWSAccess</code> SCP still attached, and specify <code>\"Effect\": \"Deny\"</code> in the second SCP to override the <code>\"Effect\": \"Allow\"</code> in the <code>FullAWSAccess</code> policy (or any other attached SCP), you're using the authorization strategy of <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_blacklist\">blacklisting</a>. </p> <p>This operation can be called only from the organization's master account.</p>"
"documentation":"<p>Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.</p> <p> <b>Note:</b> Every root, OU, and account must have at least one SCP attached. If you want to replace the default <code>FullAWSAccess</code> policy with one that limits the permissions that can be delegated, you must attach the replacement policy before you can remove the default one. This is the authorization strategy of <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_whitelist\">whitelisting</a>. If you instead attach a second SCP and leave the <code>FullAWSAccess</code> SCP still attached, and specify <code>\"Effect\": \"Deny\"</code> in the second SCP to override the <code>\"Effect\": \"Allow\"</code> in the <code>FullAWSAccess</code> policy (or any other attached SCP), you're using the authorization strategy of <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_blacklist\">blacklisting</a> . </p> <p>This operation can be called only from the organization's master account.</p>"
},
"DisableAWSServiceAccess":{
"name":"DisableAWSServiceAccess",
@ -423,7 +423,7 @@
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"<p>Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This operation can be called only from the organization's master account.</p> <note> <p>If you disable a policy type for a root, it still shows as enabled for the organization if all features are enabled in that organization. Use <a>ListRoots</a> to see the status of policy types for a specified root. Use <a>DescribeOrganization</a> to see the status of policy types in the organization.</p> </note>"
"documentation":"<p>Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This is an asynchronous request that AWS performs in the background. If you disable a policy for a root, it still appears enabled for the organization if <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">all features</a> are enabled for the organization. AWS recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation. </p> <p>This operation can be called only from the organization's master account.</p> <p> To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
},
"EnableAWSServiceAccess":{
"name":"EnableAWSServiceAccess",
@ -482,7 +482,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"PolicyTypeNotAvailableForOrganizationException"}
],
"documentation":"<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation.</p> <p>This operation can be called only from the organization's master account.</p> <p>You can enable a policy type in a root only if that policy type is available in the organization. Use <a>DescribeOrganization</a> to view the status of available policy types in the organization.</p> <p>To view the status of policy type in a root, use <a>ListRoots</a>.</p>"
"documentation":"<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation.</p> <p>This is an asynchronous request that AWS performs in the background. AWS recommends that you first use <a>ListRoots</a> to see the status of policy types for a specified root, and then use this operation. </p> <p>This operation can be called only from the organization's master account.</p> <p>You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use <a>DescribeOrganization</a>.</p>"
},
"InviteAccountToOrganization":{
"name":"InviteAccountToOrganization",
@ -1057,7 +1057,7 @@
},
"TargetId":{
"shape":"PolicyTargetId",
"documentation":"<p>The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a target ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Account: a string that consists of exactly 12 digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a target ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Account</b> - A string that consists of exactly 12 digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
}
}
},
@ -1309,7 +1309,7 @@
"members":{
"FeatureSet":{
"shape":"OrganizationFeatureSet",
"documentation":"<p>Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.</p> <ul> <li> <p> <code>CONSOLIDATED_BILLING</code>: All member accounts have their bills consolidated to and paid by the master account. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only\">Consolidated billing</a> in the <i>AWS Organizations User Guide.</i> </p> <p> The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.</p> </li> <li> <p> <code>ALL</code>: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any type of policy to any member account in the organization. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all\">All features</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul>"
"documentation":"<p>Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.</p> <ul> <li> <p> <code>CONSOLIDATED_BILLING</code>: All member accounts have their bills consolidated to and paid by the master account. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-cb-only\">Consolidated billing</a> in the <i>AWS Organizations User Guide.</i> </p> <p> The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.</p> </li> <li> <p> <code>ALL</code>: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any policy type to any member account in the organization. For more information, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#feature-set-all\">All features</a> in the <i>AWS Organizations User Guide.</i> </p> </li> </ul>"
}
}
},
@ -1331,7 +1331,7 @@
"members":{
"ParentId":{
"shape":"ParentId",
"documentation":"<p>The unique identifier (ID) of the parent root or OU that you want to create the new OU in.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the parent root or OU that you want to create the new OU in.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
},
"Name":{
"shape":"OrganizationalUnitName",
@ -1448,7 +1448,7 @@
"members":{
"CreateAccountRequestId":{
"shape":"CreateAccountRequestId",
"documentation":"<p>Specifies the <code>operationId</code> that uniquely identifies the request. You can get the ID from the response to an earlier <a>CreateAccount</a> request, or from the <a>ListCreateAccountStatus</a> operation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for an create account request ID string requires \"car-\" followed by from 8 to 32 lower-case letters or digits.</p>"
"documentation":"<p>Specifies the <code>operationId</code> that uniquely identifies the request. You can get the ID from the response to an earlier <a>CreateAccount</a> request, or from the <a>ListCreateAccountStatus</a> operation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a create account request ID string requires \"car-\" followed by from 8 to 32 lower-case letters or digits.</p>"
}
}
},
@ -1548,7 +1548,7 @@
},
"TargetId":{
"shape":"PolicyTargetId",
"documentation":"<p>The unique identifier (ID) of the root, OU, or account that you want to detach the policy from. You can get the ID from the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a target ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Account: a string that consists of exactly 12 digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the root, OU, or account that you want to detach the policy from. You can get the ID from the <a>ListRoots</a>, <a>ListOrganizationalUnitsForParent</a>, or <a>ListAccounts</a> operations.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a target ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Account</b> - A string that consists of exactly 12 digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
}
}
},
@ -2074,7 +2074,7 @@
"members":{
"ParentId":{
"shape":"ParentId",
"documentation":"<p>The unique identifier (ID) for the parent root or OU whose children you want to list.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) for the parent root or OU whose children you want to list.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
},
"ChildType":{
"shape":"ChildType",
@ -2199,7 +2199,7 @@
"members":{
"ParentId":{
"shape":"ParentId",
"documentation":"<p>The unique identifier (ID) of the root or OU whose child OUs you want to list.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the root or OU whose child OUs you want to list.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
},
"NextToken":{
"shape":"NextToken",
@ -2230,7 +2230,7 @@
"members":{
"ChildId":{
"shape":"ChildId",
"documentation":"<p>The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a child ID string requires one of the following:</p> <ul> <li> <p>Account: a string that consists of exactly 12 digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a child ID string requires one of the following:</p> <ul> <li> <p> <b>Account</b> - A string that consists of exactly 12 digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
},
"NextToken":{
"shape":"NextToken",
@ -2264,7 +2264,7 @@
"members":{
"TargetId":{
"shape":"PolicyTargetId",
"documentation":"<p>The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a target ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Account: a string that consists of exactly 12 digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a target ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Account</b> - A string that consists of exactly 12 digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
},
"Filter":{
"shape":"PolicyType",
@ -2444,11 +2444,11 @@
},
"SourceParentId":{
"shape":"ParentId",
"documentation":"<p>The unique identifier (ID) of the root or organizational unit that you want to move the account from.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the root or organizational unit that you want to move the account from.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
},
"DestinationParentId":{
"shape":"ParentId",
"documentation":"<p>The unique identifier (ID) of the root or organizational unit that you want to move the account to.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p>Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p>Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
"documentation":"<p>The unique identifier (ID) of the root or organizational unit that you want to move the account to.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a parent ID string requires one of the following:</p> <ul> <li> <p> <b>Root</b> - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.</p> </li> <li> <p> <b>Organizational unit (OU)</b> - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.</p> </li> </ul>"
}
}
},

7
botocore/data/personalize-runtime/2018-05-22/service-2.json
View file

@ -114,8 +114,7 @@
},
"InputList":{
"type":"list",
"member":{"shape":"ItemID"},
"max":100
"member":{"shape":"ItemID"}
},
"InvalidInputException":{
"type":"structure",
@ -132,12 +131,10 @@
},
"ItemList":{
"type":"list",
"member":{"shape":"PredictedItem"},
"max":100
"member":{"shape":"PredictedItem"}
},
"NumResults":{
"type":"integer",
"max":100,
"min":0
},
"PredictedItem":{

17
botocore/data/personalize/2018-05-22/service-2.json
View file

@ -76,7 +76,8 @@
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source.</p> <important> <p>The dataset import job replaces any previous data in the dataset.</p> </important> <p> <b>Status</b> </p> <p>A dataset import job can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p> </li> </ul> <p>To get the status of the import job, call <a>DescribeDatasetImportJob</a>, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a <code>failureReason</code> key, which describes why the job failed.</p> <note> <p>Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.</p> </note> <p class=\"title\"> <b>Related APIs</b> </p> <ul> <li> <p> <a>ListDatasetImportJobs</a> </p> </li> <li> <p> <a>DescribeDatasetImportJob</a> </p> </li> </ul>"
},
@ -528,7 +529,8 @@
"output":{"shape":"ListSolutionVersionsResponse"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see <a>CreateSolution</a>.</p>",
"idempotent":true
@ -669,6 +671,7 @@
"type":"string",
"max":10000
},
"Boolean":{"type":"boolean"},
"Campaign":{
"type":"structure",
"members":{
@ -1030,7 +1033,7 @@
"documentation":"<p>The name for the solution.</p>"
},
"performHPO":{
"shape":"PerformHPO",
"shape":"Boolean",
"documentation":"<p>Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is <code>false</code>.</p> <p>When performing AutoML, this parameter is always <code>true</code> and you should not set it to <code>false</code>.</p>"
},
"performAutoML":{
@ -2592,6 +2595,10 @@
"shape":"SolutionConfig",
"documentation":"<p>Describes the configuration properties for the solution.</p>"
},
"trainingHours":{
"shape":"TrainingHours",
"documentation":"<p>The time used to train the model. </p>"
},
"status":{
"shape":"Status",
"documentation":"<p>The status of the solution version.</p> <p>A solution version can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED</p> </li> </ul>"
@ -2655,6 +2662,10 @@
"type":"string",
"max":256
},
"TrainingHours":{
"type":"double",
"min":0
},
"TrainingInputMode":{
"type":"string",
"max":256

3
botocore/data/qldb-session/2019-07-11/paginators-1.json Normal file
View file

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

381
botocore/data/qldb-session/2019-07-11/service-2.json Normal file
View file

@ -0,0 +1,381 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2019-07-11",
"endpointPrefix":"session.qldb",
"jsonVersion":"1.0",
"protocol":"json",
"serviceAbbreviation":"QLDB Session",
"serviceFullName":"Amazon QLDB Session",
"serviceId":"QLDB Session",
"signatureVersion":"v4",
"signingName":"qldb",
"targetPrefix":"QLDBSession",
"uid":"qldb-session-2019-07-11"
},
"operations":{
"SendCommand":{
"name":"SendCommand",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SendCommandRequest"},
"output":{"shape":"SendCommandResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InvalidSessionException"},
{"shape":"OccConflictException"},
{"shape":"RateExceededException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Sends a command to an Amazon QLDB ledger.</p>"
}
},
"shapes":{
"AbortTransactionRequest":{
"type":"structure",
"members":{
},
"documentation":"<p>Contains the details of the transaction to abort.</p>"
},
"AbortTransactionResult":{
"type":"structure",
"members":{
},
"documentation":"<p>Contains the details of the aborted transaction.</p>"
},
"BadRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Code":{"shape":"ErrorCode"}
},
"documentation":"<p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>",
"exception":true
},
"CommitDigest":{"type":"blob"},
"CommitTransactionRequest":{
"type":"structure",
"required":[
"TransactionId",
"CommitDigest"
],
"members":{
"TransactionId":{
"shape":"TransactionId",
"documentation":"<p>Specifies the transaction id of the transaction to commit.</p>"
},
"CommitDigest":{
"shape":"CommitDigest",
"documentation":"<p>Specifies the commit digest for the transaction to commit. For every active transaction, the commit digest must be passed. QLDB validates <code>CommitDigest</code> and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.</p>"
}
},
"documentation":"<p>Contains the details of the transaction to commit.</p>"
},
"CommitTransactionResult":{
"type":"structure",
"members":{
"TransactionId":{
"shape":"TransactionId",
"documentation":"<p>The transaction id of the committed transaction.</p>"
},
"CommitDigest":{
"shape":"CommitDigest",
"documentation":"<p>The commit digest of the committed transaction.</p>"
}
},
"documentation":"<p>Contains the details of the committed transaction.</p>"
},
"EndSessionRequest":{
"type":"structure",
"members":{
},
"documentation":"<p>Specifies a request to end the session.</p>"
},
"EndSessionResult":{
"type":"structure",
"members":{
},
"documentation":"<p>Contains the details of the ended session.</p>"
},
"ErrorCode":{"type":"string"},
"ErrorMessage":{"type":"string"},
"ExecuteStatementRequest":{
"type":"structure",
"required":[
"TransactionId",
"Statement"
],
"members":{
"TransactionId":{
"shape":"TransactionId",
"documentation":"<p>Specifies the transaction id of the request.</p>"
},
"Statement":{
"shape":"Statement",
"documentation":"<p>Specifies the statement of the request.</p>"
},
"Parameters":{
"shape":"StatementParameters",
"documentation":"<p>Specifies the parameters for the parameterized statement in the request.</p>"
}
},
"documentation":"<p>Specifies a request to execute a statement.</p>"
},
"ExecuteStatementResult":{
"type":"structure",
"members":{
"FirstPage":{
"shape":"Page",
"documentation":"<p>Contains the details of the first fetched page.</p>"
}
},
"documentation":"<p>Contains the details of the executed statement.</p>"
},
"FetchPageRequest":{
"type":"structure",
"required":[
"TransactionId",
"NextPageToken"
],
"members":{
"TransactionId":{
"shape":"TransactionId",
"documentation":"<p>Specifies the transaction id of the page to be fetched.</p>"
},
"NextPageToken":{
"shape":"PageToken",
"documentation":"<p>Specifies the next page token of the page to be fetched.</p>"
}
},
"documentation":"<p>Specifies the details of the page to be fetched.</p>"
},
"FetchPageResult":{
"type":"structure",
"members":{
"Page":{
"shape":"Page",
"documentation":"<p>Contains details of the fetched page.</p>"
}
},
"documentation":"<p>Contains the page that was fetched.</p>"
},
"InvalidSessionException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Code":{"shape":"ErrorCode"}
},
"documentation":"<p>Returned if the session doesn't exist anymore because it timed-out or expired.</p>",
"exception":true
},
"IonBinary":{
"type":"blob",
"max":131072,
"min":1
},
"IonText":{
"type":"string",
"max":1048576,
"min":1
},
"LedgerName":{
"type":"string",
"max":32,
"min":1,
"pattern":"(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$"
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned if a resource limit such as number of active sessions is exceeded.</p>",
"exception":true
},
"OccConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned when a transaction cannot be written to the journal due to a failure in the verification phase of Optimistic Concurrency Control.</p>",
"exception":true
},
"Page":{
"type":"structure",
"members":{
"Values":{
"shape":"ValueHolders",
"documentation":"<p>A structure that contains values in multiple encoding formats.</p>"
},
"NextPageToken":{
"shape":"PageToken",
"documentation":"<p>The token of the next page.</p>"
}
},
"documentation":"<p>Contains details of the fetched page.</p>"
},
"PageToken":{
"type":"string",
"max":1024,
"min":4,
"pattern":"^[A-Za-z-0-9+/=]+$"
},
"RateExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned when the rate of requests exceeds the allowed throughput.</p>",
"exception":true
},
"SendCommandRequest":{
"type":"structure",
"members":{
"SessionToken":{
"shape":"SessionToken",
"documentation":"<p>Specifies the session token for the current command. A session token is constant throughout the life of the session.</p> <p>To obtain a session token, run the <code>StartSession</code> command. This <code>SessionToken</code> is required for every subsequent command that is issued during the current session.</p>"
},
"StartSession":{
"shape":"StartSessionRequest",
"documentation":"<p>Command to start a new session. A session token is obtained as part of the response.</p>"
},
"StartTransaction":{
"shape":"StartTransactionRequest",
"documentation":"<p>Command to start a new transaction.</p>"
},
"EndSession":{
"shape":"EndSessionRequest",
"documentation":"<p>Command to end the current session.</p>"
},
"CommitTransaction":{
"shape":"CommitTransactionRequest",
"documentation":"<p>Command to commit the specified transaction.</p>"
},
"AbortTransaction":{
"shape":"AbortTransactionRequest",
"documentation":"<p>Command to abort the current transaction.</p>"
},
"ExecuteStatement":{
"shape":"ExecuteStatementRequest",
"documentation":"<p>Command to execute a statement in the specified transaction.</p>"
},
"FetchPage":{
"shape":"FetchPageRequest",
"documentation":"<p>Command to fetch a page.</p>"
}
}
},
"SendCommandResult":{
"type":"structure",
"members":{
"StartSession":{
"shape":"StartSessionResult",
"documentation":"<p>Contains the details of the started session that includes a session token. This <code>SessionToken</code> is required for every subsequent command that is issued during the current session.</p>"
},
"StartTransaction":{
"shape":"StartTransactionResult",
"documentation":"<p>Contains the details of the started transaction.</p>"
},
"EndSession":{
"shape":"EndSessionResult",
"documentation":"<p>Contains the details of the ended session.</p>"
},
"CommitTransaction":{
"shape":"CommitTransactionResult",
"documentation":"<p>Contains the details of the committed transaction.</p>"
},
"AbortTransaction":{
"shape":"AbortTransactionResult",
"documentation":"<p>Contains the details of the aborted transaction.</p>"
},
"ExecuteStatement":{
"shape":"ExecuteStatementResult",
"documentation":"<p>Contains the details of the executed statement.</p>"
},
"FetchPage":{
"shape":"FetchPageResult",
"documentation":"<p>Contains the details of the fetched page.</p>"
}
}
},
"SessionToken":{
"type":"string",
"max":1024,
"min":4,
"pattern":"^[A-Za-z-0-9+/=]+$"
},
"StartSessionRequest":{
"type":"structure",
"required":["LedgerName"],
"members":{
"LedgerName":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger to start a new session against.</p>"
}
},
"documentation":"<p>Specifies a request to start a a new session.</p>"
},
"StartSessionResult":{
"type":"structure",
"members":{
"SessionToken":{
"shape":"SessionToken",
"documentation":"<p>Session token of the started session. This <code>SessionToken</code> is required for every subsequent command that is issued during the current session.</p>"
}
},
"documentation":"<p>Contains the details of the started session.</p>"
},
"StartTransactionRequest":{
"type":"structure",
"members":{
},
"documentation":"<p>Specifies a request to start a transaction.</p>"
},
"StartTransactionResult":{
"type":"structure",
"members":{
"TransactionId":{
"shape":"TransactionId",
"documentation":"<p>The transaction id of the started transaction.</p>"
}
},
"documentation":"<p>Contains the details of the started transaction.</p>"
},
"Statement":{
"type":"string",
"max":100000,
"min":1
},
"StatementParameters":{
"type":"list",
"member":{"shape":"ValueHolder"}
},
"TransactionId":{
"type":"string",
"max":22,
"min":22,
"pattern":"^[A-Za-z-0-9]+$"
},
"ValueHolder":{
"type":"structure",
"members":{
"IonBinary":{
"shape":"IonBinary",
"documentation":"<p>An Amazon Ion binary value contained in a <code>ValueHolder</code> structure. </p>"
},
"IonText":{
"shape":"IonText",
"documentation":"<p>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure. </p>"
}
},
"documentation":"<p>A structure that can contains values in multiple encoding formats.</p>"
},
"ValueHolders":{
"type":"list",
"member":{"shape":"ValueHolder"}
}
},
"documentation":"<p>The transactional data APIs for Amazon QLDB</p>"
}

3
botocore/data/qldb/2019-01-02/paginators-1.json Normal file
View file

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

1036
botocore/data/qldb/2019-01-02/service-2.json Normal file
View file

@ -0,0 +1,1036 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2019-01-02",
"endpointPrefix":"qldb",
"jsonVersion":"1.0",
"protocol":"rest-json",
"serviceAbbreviation":"QLDB",
"serviceFullName":"Amazon QLDB",
"serviceId":"QLDB",
"signatureVersion":"v4",
"signingName":"qldb",
"uid":"qldb-2019-01-02"
},
"operations":{
"CreateLedger":{
"name":"CreateLedger",
"http":{
"method":"POST",
"requestUri":"/ledgers"
},
"input":{"shape":"CreateLedgerRequest"},
"output":{"shape":"CreateLedgerResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Creates a new ledger in your AWS account.</p>"
},
"DeleteLedger":{
"name":"DeleteLedger",
"http":{
"method":"DELETE",
"requestUri":"/ledgers/{name}"
},
"input":{"shape":"DeleteLedgerRequest"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"ResourcePreconditionNotMetException"}
],
"documentation":"<p>Deletes a ledger and all of its contents. This action is irreversible.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</p>"
},
"DescribeJournalS3Export":{
"name":"DescribeJournalS3Export",
"http":{
"method":"GET",
"requestUri":"/ledgers/{name}/journal-s3-exports/{exportId}"
},
"input":{"shape":"DescribeJournalS3ExportRequest"},
"output":{"shape":"DescribeJournalS3ExportResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.</p> <p>If the export job with the given <code>ExportId</code> doesn't exist, then throws <code>ResourceNotFoundException</code>.</p> <p>If the ledger with the given <code>Name</code> doesn't exist, then throws <code>ResourceNotFoundException</code>.</p>"
},
"DescribeLedger":{
"name":"DescribeLedger",
"http":{
"method":"GET",
"requestUri":"/ledgers/{name}"
},
"input":{"shape":"DescribeLedgerRequest"},
"output":{"shape":"DescribeLedgerResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns information about a ledger, including its state and when it was created.</p>"
},
"ExportJournalToS3":{
"name":"ExportJournalToS3",
"http":{
"method":"POST",
"requestUri":"/ledgers/{name}/journal-s3-exports"
},
"input":{"shape":"ExportJournalToS3Request"},
"output":{"shape":"ExportJournalToS3Response"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourcePreconditionNotMetException"}
],
"documentation":"<p>Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.</p> <p>If the ledger with the given <code>Name</code> doesn't exist, then throws <code>ResourceNotFoundException</code>.</p> <p>If the ledger with the given <code>Name</code> is in <code>CREATING</code> status, then throws <code>ResourcePreconditionNotMetException</code>.</p> <p>You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw <code>LimitExceededException</code>.</p>"
},
"GetBlock":{
"name":"GetBlock",
"http":{
"method":"POST",
"requestUri":"/ledgers/{name}/block"
},
"input":{"shape":"GetBlockRequest"},
"output":{"shape":"GetBlockResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourcePreconditionNotMetException"}
],
"documentation":"<p>Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block for verification if <code>DigestTipAddress</code> is provided.</p> <p>If the specified ledger doesn't exist or is in <code>DELETING</code> status, then throws <code>ResourceNotFoundException</code>.</p> <p>If the specified ledger is in <code>CREATING</code> status, then throws <code>ResourcePreconditionNotMetException</code>.</p> <p>If no block exists with the specified address, then throws <code>InvalidParameterException</code>.</p>"
},
"GetDigest":{
"name":"GetDigest",
"http":{
"method":"POST",
"requestUri":"/ledgers/{name}/digest"
},
"input":{"shape":"GetDigestRequest"},
"output":{"shape":"GetDigestResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourcePreconditionNotMetException"}
],
"documentation":"<p>Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.</p>"
},
"GetRevision":{
"name":"GetRevision",
"http":{
"method":"POST",
"requestUri":"/ledgers/{name}/revision"
},
"input":{"shape":"GetRevisionRequest"},
"output":{"shape":"GetRevisionResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourcePreconditionNotMetException"}
],
"documentation":"<p>Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if <code>DigestTipAddress</code> is provided.</p>"
},
"ListJournalS3Exports":{
"name":"ListJournalS3Exports",
"http":{
"method":"GET",
"requestUri":"/journal-s3-exports"
},
"input":{"shape":"ListJournalS3ExportsRequest"},
"output":{"shape":"ListJournalS3ExportsResponse"},
"documentation":"<p>Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.</p> <p>This action returns a maximum of <code>MaxResults</code> items, and is paginated so that you can retrieve all the items by calling <code>ListJournalS3Exports</code> multiple times.</p>"
},
"ListJournalS3ExportsForLedger":{
"name":"ListJournalS3ExportsForLedger",
"http":{
"method":"GET",
"requestUri":"/ledgers/{name}/journal-s3-exports"
},
"input":{"shape":"ListJournalS3ExportsForLedgerRequest"},
"output":{"shape":"ListJournalS3ExportsForLedgerResponse"},
"documentation":"<p>Returns an array of journal export job descriptions for a specified ledger.</p> <p>This action returns a maximum of <code>MaxResults</code> items, and is paginated so that you can retrieve all the items by calling <code>ListJournalS3ExportsForLedger</code> multiple times.</p>"
},
"ListLedgers":{
"name":"ListLedgers",
"http":{
"method":"GET",
"requestUri":"/ledgers"
},
"input":{"shape":"ListLedgersRequest"},
"output":{"shape":"ListLedgersResponse"},
"documentation":"<p>Returns an array of ledger summaries that are associated with the current AWS account and Region.</p> <p>This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling <code>ListLedgers</code> multiple times.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns all tags for a specified Amazon QLDB resource.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds one or more tags to a specified Amazon QLDB resource.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.</p>"
},
"UpdateLedger":{
"name":"UpdateLedger",
"http":{
"method":"PATCH",
"requestUri":"/ledgers/{name}"
},
"input":{"shape":"UpdateLedgerRequest"},
"output":{"shape":"UpdateLedgerResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates properties on a ledger.</p>"
}
},
"shapes":{
"Arn":{
"type":"string",
"max":1600,
"min":20
},
"CreateLedgerRequest":{
"type":"structure",
"required":[
"Name",
"PermissionsMode"
],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.</p>"
},
"PermissionsMode":{
"shape":"PermissionsMode",
"documentation":"<p>The permissions mode to assign to the ledger that you want to create.</p>"
},
"DeletionProtection":{
"shape":"DeletionProtection",
"documentation":"<p>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</p>"
}
}
},
"CreateLedgerResponse":{
"type":"structure",
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the ledger.</p>"
},
"State":{
"shape":"LedgerState",
"documentation":"<p>The current status of the ledger.</p>"
},
"CreationDateTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)</p>"
},
"DeletionProtection":{
"shape":"DeletionProtection",
"documentation":"<p>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</p>"
}
}
},
"DeleteLedgerRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger that you want to delete.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DeletionProtection":{"type":"boolean"},
"DescribeJournalS3ExportRequest":{
"type":"structure",
"required":[
"Name",
"ExportId"
],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>",
"location":"uri",
"locationName":"name"
},
"ExportId":{
"shape":"UniqueId",
"documentation":"<p>The unique ID of the journal export job that you want to describe.</p>",
"location":"uri",
"locationName":"exportId"
}
}
},
"DescribeJournalS3ExportResponse":{
"type":"structure",
"required":["ExportDescription"],
"members":{
"ExportDescription":{
"shape":"JournalS3ExportDescription",
"documentation":"<p>Information about the journal export job returned by a <code>DescribeJournalS3Export</code> request.</p>"
}
}
},
"DescribeLedgerRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger that you want to describe.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DescribeLedgerResponse":{
"type":"structure",
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the ledger.</p>"
},
"State":{
"shape":"LedgerState",
"documentation":"<p>The current status of the ledger.</p>"
},
"CreationDateTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)</p>"
},
"DeletionProtection":{
"shape":"DeletionProtection",
"documentation":"<p>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</p>"
}
}
},
"Digest":{
"type":"blob",
"max":32,
"min":32
},
"ErrorMessage":{"type":"string"},
"ExportJournalToS3Request":{
"type":"structure",
"required":[
"Name",
"InclusiveStartTime",
"ExclusiveEndTime",
"S3ExportConfiguration",
"RoleArn"
],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>",
"location":"uri",
"locationName":"name"
},
"InclusiveStartTime":{
"shape":"Timestamp",
"documentation":"<p>The inclusive start date and time for the range of journal contents that you want to export.</p> <p>The <code>InclusiveStartTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code> </p> <p>The <code>InclusiveStartTime</code> must be before <code>ExclusiveEndTime</code>.</p> <p>If you provide an <code>InclusiveStartTime</code> that is before the ledger's <code>CreationDateTime</code>, Amazon QLDB defaults it to the ledger's <code>CreationDateTime</code>.</p>"
},
"ExclusiveEndTime":{
"shape":"Timestamp",
"documentation":"<p>The exclusive end date and time for the range of journal contents that you want to export.</p> <p>The <code>ExclusiveEndTime</code> must be in <code>ISO 8601</code> date and time format and in Universal Coordinated Time (UTC). For example: <code>2019-06-13T21:36:34Z</code> </p> <p>The <code>ExclusiveEndTime</code> must be less than or equal to the current UTC date and time.</p>"
},
"S3ExportConfiguration":{
"shape":"S3ExportConfiguration",
"documentation":"<p>The configuration settings of the Amazon S3 bucket destination for your export request.</p>"
},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:</p> <ul> <li> <p>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</p> </li> <li> <p>(Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.</p> </li> </ul>"
}
}
},
"ExportJournalToS3Response":{
"type":"structure",
"required":["ExportId"],
"members":{
"ExportId":{
"shape":"UniqueId",
"documentation":"<p>The unique ID that QLDB assigns to each journal export job.</p> <p>To describe your export request and check the status of the job, you can use <code>ExportId</code> to call <code>DescribeJournalS3Export</code>.</p>"
}
}
},
"ExportStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"COMPLETED",
"CANCELLED"
]
},
"GetBlockRequest":{
"type":"structure",
"required":[
"Name",
"BlockAddress"
],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>",
"location":"uri",
"locationName":"name"
},
"BlockAddress":{
"shape":"ValueHolder",
"documentation":"<p>The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: <code>strandId</code> and <code>sequenceNo</code>.</p> <p>For example: <code>{strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}</code> </p>"
},
"DigestTipAddress":{
"shape":"ValueHolder",
"documentation":"<p>The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: <code>strandId</code> and <code>sequenceNo</code>.</p> <p>For example: <code>{strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}</code> </p>"
}
}
},
"GetBlockResponse":{
"type":"structure",
"required":["Block"],
"members":{
"Block":{
"shape":"ValueHolder",
"documentation":"<p>The block data object in Amazon Ion format.</p>"
},
"Proof":{
"shape":"ValueHolder",
"documentation":"<p>The proof object in Amazon Ion format returned by a <code>GetBlock</code> request. A proof contains the list of hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block.</p>"
}
}
},
"GetDigestRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"GetDigestResponse":{
"type":"structure",
"required":[
"Digest",
"DigestTipAddress"
],
"members":{
"Digest":{
"shape":"Digest",
"documentation":"<p>The 256-bit hash value representing the digest returned by a <code>GetDigest</code> request.</p>"
},
"DigestTipAddress":{
"shape":"ValueHolder",
"documentation":"<p>The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: <code>strandId</code> and <code>sequenceNo</code>.</p>"
}
}
},
"GetRevisionRequest":{
"type":"structure",
"required":[
"Name",
"BlockAddress",
"DocumentId"
],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>",
"location":"uri",
"locationName":"name"
},
"BlockAddress":{
"shape":"ValueHolder",
"documentation":"<p>The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: <code>strandId</code> and <code>sequenceNo</code>.</p> <p>For example: <code>{strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}</code> </p>"
},
"DocumentId":{
"shape":"UniqueId",
"documentation":"<p>The unique ID of the document to be verified.</p>"
},
"DigestTipAddress":{
"shape":"ValueHolder",
"documentation":"<p>The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: <code>strandId</code> and <code>sequenceNo</code>.</p> <p>For example: <code>{strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}</code> </p>"
}
}
},
"GetRevisionResponse":{
"type":"structure",
"required":["Revision"],
"members":{
"Proof":{
"shape":"ValueHolder",
"documentation":"<p>The proof object in Amazon Ion format returned by a <code>GetRevision</code> request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.</p>"
},
"Revision":{
"shape":"ValueHolder",
"documentation":"<p>The document revision data object in Amazon Ion format.</p>"
}
}
},
"InvalidParameterException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ParameterName":{
"shape":"ParameterName",
"documentation":"<p>The name of the invalid parameter.</p>"
}
},
"documentation":"<p>One or more parameters in the request aren't valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"IonText":{
"type":"string",
"max":1048576,
"min":1,
"sensitive":true
},
"JournalS3ExportDescription":{
"type":"structure",
"required":[
"LedgerName",
"ExportId",
"ExportCreationTime",
"Status",
"InclusiveStartTime",
"ExclusiveEndTime",
"S3ExportConfiguration",
"RoleArn"
],
"members":{
"LedgerName":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>"
},
"ExportId":{
"shape":"UniqueId",
"documentation":"<p>The unique ID of the journal export job.</p>"
},
"ExportCreationTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)</p>"
},
"Status":{
"shape":"ExportStatus",
"documentation":"<p>The current state of the journal export job.</p>"
},
"InclusiveStartTime":{
"shape":"Timestamp",
"documentation":"<p>The inclusive start date and time for the range of journal contents that are specified in the original export request.</p>"
},
"ExclusiveEndTime":{
"shape":"Timestamp",
"documentation":"<p>The exclusive end date and time for the range of journal contents that are specified in the original export request.</p>"
},
"S3ExportConfiguration":{"shape":"S3ExportConfiguration"},
"RoleArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:</p> <ul> <li> <p>Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.</p> </li> <li> <p>(Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.</p> </li> </ul>"
}
},
"documentation":"<p>The information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.</p>"
},
"JournalS3ExportList":{
"type":"list",
"member":{"shape":"JournalS3ExportDescription"}
},
"LedgerList":{
"type":"list",
"member":{"shape":"LedgerSummary"}
},
"LedgerName":{
"type":"string",
"max":32,
"min":1,
"pattern":"(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$"
},
"LedgerState":{
"type":"string",
"enum":[
"CREATING",
"ACTIVE",
"DELETING",
"DELETED"
]
},
"LedgerSummary":{
"type":"structure",
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>"
},
"State":{
"shape":"LedgerState",
"documentation":"<p>The current status of the ledger.</p>"
},
"CreationDateTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)</p>"
}
},
"documentation":"<p>Information about a ledger, including its name, state, and when it was created.</p>"
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource.</p>"
}
},
"documentation":"<p>You have reached the limit on the maximum number of resources allowed.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"ListJournalS3ExportsForLedgerRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>",
"location":"uri",
"locationName":"name"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in a single <code>ListJournalS3ExportsForLedger</code> request. (The actual number of results returned might be fewer.)</p>",
"location":"querystring",
"locationName":"max_results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListJournalS3ExportsForLedger</code> call, then you should use that value as input here.</p>",
"location":"querystring",
"locationName":"next_token"
}
}
},
"ListJournalS3ExportsForLedgerResponse":{
"type":"structure",
"members":{
"JournalS3Exports":{
"shape":"JournalS3ExportList",
"documentation":"<p>The array of journal export job descriptions that are associated with the specified ledger.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<ul> <li> <p>If <code>NextToken</code> is empty, then the last page of results has been processed and there are no more results to be retrieved.</p> </li> <li> <p>If <code>NextToken</code> is <i>not</i> empty, then there are more results available. To retrieve the next page of results, use the value of <code>NextToken</code> in a subsequent <code>ListJournalS3ExportsForLedger</code> call.</p> </li> </ul>"
}
}
},
"ListJournalS3ExportsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in a single <code>ListJournalS3Exports</code> request. (The actual number of results returned might be fewer.)</p>",
"location":"querystring",
"locationName":"max_results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListJournalS3Exports</code> call, then you should use that value as input here.</p>",
"location":"querystring",
"locationName":"next_token"
}
}
},
"ListJournalS3ExportsResponse":{
"type":"structure",
"members":{
"JournalS3Exports":{
"shape":"JournalS3ExportList",
"documentation":"<p>The array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<ul> <li> <p>If <code>NextToken</code> is empty, then the last page of results has been processed and there are no more results to be retrieved.</p> </li> <li> <p>If <code>NextToken</code> is <i>not</i> empty, then there are more results available. To retrieve the next page of results, use the value of <code>NextToken</code> in a subsequent <code>ListJournalS3Exports</code> call.</p> </li> </ul>"
}
}
},
"ListLedgersRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return in a single <code>ListLedgers</code> request. (The actual number of results returned might be fewer.)</p>",
"location":"querystring",
"locationName":"max_results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token, indicating that you want to retrieve the next page of results. If you received a value for <code>NextToken</code> in the response from a previous <code>ListLedgers</code> call, then you should use that value as input here.</p>",
"location":"querystring",
"locationName":"next_token"
}
}
},
"ListLedgersResponse":{
"type":"structure",
"members":{
"Ledgers":{
"shape":"LedgerList",
"documentation":"<p>The array of ledger summaries that are associated with the current AWS account and Region.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A pagination token, indicating whether there are more results available:</p> <ul> <li> <p>If <code>NextToken</code> is empty, then the last page of results has been processed and there are no more results to be retrieved.</p> </li> <li> <p>If <code>NextToken</code> is <i>not</i> empty, then there are more results available. To retrieve the next page of results, use the value of <code>NextToken</code> in a subsequent <code>ListLedgers</code> call.</p> </li> </ul>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for which you want to list the tags. For example:</p> <p> <code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code> </p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags that are currently associated with the specified Amazon QLDB resource.</p>"
}
}
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"NextToken":{
"type":"string",
"max":1024,
"min":4,
"pattern":"^[A-Za-z-0-9+/=]+$"
},
"ParameterName":{"type":"string"},
"PermissionsMode":{
"type":"string",
"enum":["ALLOW_ALL"]
},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource.</p>"
},
"ResourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the resource.</p>"
}
},
"documentation":"<p>The specified resource already exists.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource.</p>"
},
"ResourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the resource.</p>"
}
},
"documentation":"<p>The specified resource can't be modified at this time.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceName":{"type":"string"},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource.</p>"
},
"ResourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the resource.</p>"
}
},
"documentation":"<p>The specified resource doesn't exist.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"ResourcePreconditionNotMetException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource.</p>"
},
"ResourceName":{
"shape":"ResourceName",
"documentation":"<p>The name of the resource.</p>"
}
},
"documentation":"<p>The operation failed because a condition wasn't satisfied in advance.</p>",
"error":{"httpStatusCode":412},
"exception":true
},
"ResourceType":{"type":"string"},
"S3Bucket":{
"type":"string",
"max":255,
"min":3,
"pattern":"^[A-Za-z-0-9-_.]+$"
},
"S3EncryptionConfiguration":{
"type":"structure",
"required":["ObjectEncryptionType"],
"members":{
"ObjectEncryptionType":{
"shape":"S3ObjectEncryptionType",
"documentation":"<p>The Amazon S3 object encryption type.</p> <p>To learn more about server-side encryption options in Amazon S3, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html\">Protecting Data Using Server-Side Encryption</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
},
"KmsKeyArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for a customer master key (CMK) in AWS Key Management Service (AWS KMS).</p> <p>You must provide a <code>KmsKeyArn</code> if you specify <code>SSE_KMS</code> as the <code>ObjectEncryptionType</code>.</p> <p> <code>KmsKeyArn</code> is not required if you specify <code>SSE_S3</code> as the <code>ObjectEncryptionType</code>.</p>"
}
},
"documentation":"<p>The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.</p>"
},
"S3ExportConfiguration":{
"type":"structure",
"required":[
"Bucket",
"Prefix",
"EncryptionConfiguration"
],
"members":{
"Bucket":{
"shape":"S3Bucket",
"documentation":"<p>The Amazon S3 bucket name in which a journal export job writes the journal contents.</p> <p>The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html\">Bucket Restrictions and Limitations</a> in the <i>Amazon S3 Developer Guide</i>.</p>"
},
"Prefix":{
"shape":"S3Prefix",
"documentation":"<p>The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.</p> <p>The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html\">Object Key and Metadata</a> in the <i>Amazon S3 Developer Guide</i>.</p> <p>The following are examples of valid <code>Prefix</code> values:</p> <ul> <li> <p> <code>JournalExports-ForMyLedger/Testing/</code> </p> </li> <li> <p> <code>JournalExports</code> </p> </li> <li> <p> <code>My:Tests/</code> </p> </li> </ul>"
},
"EncryptionConfiguration":{
"shape":"S3EncryptionConfiguration",
"documentation":"<p>The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.</p>"
}
},
"documentation":"<p>The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.</p>"
},
"S3ObjectEncryptionType":{
"type":"string",
"enum":[
"SSE_KMS",
"SSE_S3",
"NO_ENCRYPTION"
]
},
"S3Prefix":{
"type":"string",
"max":128,
"min":0
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":0
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) to which you want to add the tags. For example:</p> <p> <code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code> </p>",
"location":"uri",
"locationName":"resourceArn"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"Tags":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":200,
"min":0
},
"Timestamp":{"type":"timestamp"},
"UniqueId":{
"type":"string",
"max":22,
"min":22,
"pattern":"^[A-Za-z-0-9]+$"
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) from which you want to remove the tags. For example:</p> <p> <code>arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger</code> </p>",
"location":"uri",
"locationName":"resourceArn"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The list of tag keys that you want to remove.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateLedgerRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>",
"location":"uri",
"locationName":"name"
},
"DeletionProtection":{
"shape":"DeletionProtection",
"documentation":"<p>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</p>"
}
}
},
"UpdateLedgerResponse":{
"type":"structure",
"members":{
"Name":{
"shape":"LedgerName",
"documentation":"<p>The name of the ledger.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the ledger.</p>"
},
"State":{
"shape":"LedgerState",
"documentation":"<p>The current status of the ledger.</p>"
},
"CreationDateTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)</p>"
},
"DeletionProtection":{
"shape":"DeletionProtection",
"documentation":"<p>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>. The QLDB console disables deletion protection for you when you use it to delete a ledger.</p>"
}
}
},
"ValueHolder":{
"type":"structure",
"members":{
"IonText":{
"shape":"IonText",
"documentation":"<p>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</p>"
}
},
"documentation":"<p>A structure that can contain an Amazon Ion value in multiple encoding formats.</p>",
"sensitive":true
}
},
"documentation":"<p>The control plane for Amazon QLDB</p>"
}

127
botocore/data/ram/2018-01-04/service-2.json
View file

@ -28,7 +28,9 @@
{"shape":"ResourceShareInvitationAlreadyRejectedException"},
{"shape":"ResourceShareInvitationExpiredException"},
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidClientTokenException"},
{"shape":"IdempotentParameterMismatchException"}
],
"documentation":"<p>Accepts an invitation to a resource share from another AWS account.</p>"
},
@ -73,6 +75,7 @@
{"shape":"InvalidParameterException"},
{"shape":"OperationNotPermittedException"},
{"shape":"ResourceShareLimitExceededException"},
{"shape":"TagPolicyViolationException"},
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
@ -134,7 +137,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Enables resource sharing within your organization.</p>"
"documentation":"<p>Enables resource sharing within your AWS Organization.</p> <p>The caller must be the master account for the AWS Organization.</p>"
},
"GetResourcePolicies":{
"name":"GetResourcePolicies",
@ -151,7 +154,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Gets the policies for the specifies resources.</p>"
"documentation":"<p>Gets the policies for the specified resources that you own and have shared.</p>"
},
"GetResourceShareAssociations":{
"name":"GetResourceShareAssociations",
@ -170,7 +173,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Gets the associations for the specified resource share.</p>"
"documentation":"<p>Gets the resources or principals for the resource shares that you own.</p>"
},
"GetResourceShareInvitations":{
"name":"GetResourceShareInvitations",
@ -189,7 +192,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Gets the specified invitations for resource sharing.</p>"
"documentation":"<p>Gets the invitations for resource sharing that you've received.</p>"
},
"GetResourceShares":{
"name":"GetResourceShares",
@ -207,7 +210,28 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Gets the specified resource shares or all of your resource shares.</p>"
"documentation":"<p>Gets the resource shares that you own or the resource shares that are shared with you.</p>"
},
"ListPendingInvitationResources":{
"name":"ListPendingInvitationResources",
"http":{
"method":"POST",
"requestUri":"/listpendinginvitationresources"
},
"input":{"shape":"ListPendingInvitationResourcesRequest"},
"output":{"shape":"ListPendingInvitationResourcesResponse"},
"errors":[
{"shape":"MalformedArnException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterException"},
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceShareInvitationArnNotFoundException"},
{"shape":"MissingRequiredParameterException"},
{"shape":"ResourceShareInvitationAlreadyRejectedException"},
{"shape":"ResourceShareInvitationExpiredException"}
],
"documentation":"<p>Lists the resources in a resource share that is shared with you but that the invitation is still pending for.</p>"
},
"ListPrincipals":{
"name":"ListPrincipals",
@ -225,7 +249,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Lists the principals with access to the specified resource.</p>"
"documentation":"<p>Lists the principals that you have shared resources with or the principals that have shared resources with you.</p>"
},
"ListResources":{
"name":"ListResources",
@ -244,7 +268,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Lists the resources that the specified principal can access.</p>"
"documentation":"<p>Lists the resources that you added to a resource shares or the resources that are shared with you.</p>"
},
"RejectResourceShareInvitation":{
"name":"RejectResourceShareInvitation",
@ -262,7 +286,9 @@
{"shape":"ResourceShareInvitationAlreadyRejectedException"},
{"shape":"ResourceShareInvitationExpiredException"},
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidClientTokenException"},
{"shape":"IdempotentParameterMismatchException"}
],
"documentation":"<p>Rejects an invitation to a resource share from another AWS account.</p>"
},
@ -279,10 +305,11 @@
{"shape":"MalformedArnException"},
{"shape":"TagLimitExceededException"},
{"shape":"ResourceArnNotFoundException"},
{"shape":"TagPolicyViolationException"},
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Adds the specified tags to the specified resource share.</p>"
"documentation":"<p>Adds the specified tags to the specified resource share that you own.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -297,7 +324,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Removes the specified tags from the specified resource share.</p>"
"documentation":"<p>Removes the specified tags from the specified resource share that you own.</p>"
},
"UpdateResourceShare":{
"name":"UpdateResourceShare",
@ -318,7 +345,7 @@
{"shape":"ServerInternalException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Updates the specified resource share.</p>"
"documentation":"<p>Updates the specified resource share that you own.</p>"
}
},
"shapes":{
@ -407,7 +434,7 @@
},
"allowExternalPrincipals":{
"shape":"Boolean",
"documentation":"<p>Indicates whether principals outside your organization can be associated with a resource share.</p>"
"documentation":"<p>Indicates whether principals outside your AWS organization can be associated with a resource share.</p>"
},
"clientToken":{
"shape":"String",
@ -558,15 +585,15 @@
},
"resourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is <code>PRINCIPAL</code>.</p>"
},
"principal":{
"shape":"String",
"documentation":"<p>The principal.</p>"
"documentation":"<p>The principal. You cannot specify this parameter if the association type is <code>RESOURCE</code>.</p>"
},
"associationStatus":{
"shape":"ResourceShareAssociationStatus",
"documentation":"<p>The status of the association.</p>"
"documentation":"<p>The association status.</p>"
},
"nextToken":{
"shape":"String",
@ -583,7 +610,7 @@
"members":{
"resourceShareAssociations":{
"shape":"ResourceShareAssociationList",
"documentation":"<p>Information about the association.</p>"
"documentation":"<p>Information about the associations.</p>"
},
"nextToken":{
"shape":"String",
@ -742,6 +769,37 @@
"error":{"httpStatusCode":400},
"exception":true
},
"ListPendingInvitationResourcesRequest":{
"type":"structure",
"required":["resourceShareInvitationArn"],
"members":{
"resourceShareInvitationArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the invitation.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token for the next page of results.</p>"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"
}
}
},
"ListPendingInvitationResourcesResponse":{
"type":"structure",
"members":{
"resources":{
"shape":"ResourceList",
"documentation":"<p>Information about the resources included the resource share.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListPrincipalsRequest":{
"type":"structure",
"required":["resourceOwner"],
@ -760,7 +818,7 @@
},
"resourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
"documentation":"<p>The resource type.</p> <p>Valid values: <code>route53resolver:ResolverRule</code> | <code>ec2:TransitGateway</code> | <code>ec2:Subnet</code> | <code>license-manager:LicenseConfiguration</code> </p>"
},
"resourceShareArns":{
"shape":"ResourceShareArnList",
@ -803,7 +861,7 @@
},
"resourceType":{
"shape":"String",
"documentation":"<p>The resource type.</p>"
"documentation":"<p>The resource type.</p> <p>Valid values: <code>route53resolver:ResolverRule</code> | <code>ec2:TransitGateway</code> | <code>ec2:Subnet</code> | <code>license-manager:LicenseConfiguration</code> </p>"
},
"resourceArns":{
"shape":"ResourceArnList",
@ -897,7 +955,7 @@
},
"external":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the principal belongs to the same organization as the AWS account that owns the resource share.</p>"
"documentation":"<p>Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.</p>"
}
},
"documentation":"<p>Describes a principal for use with AWS Resource Access Manager.</p>"
@ -1013,7 +1071,7 @@
},
"allowExternalPrincipals":{
"shape":"Boolean",
"documentation":"<p>Indicates whether principals outside your organization can be associated with a resource share.</p>"
"documentation":"<p>Indicates whether principals outside your AWS organization can be associated with a resource share.</p>"
},
"status":{
"shape":"ResourceShareStatus",
@ -1049,6 +1107,10 @@
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource share.</p>"
},
"resourceShareName":{
"shape":"String",
"documentation":"<p>The name of the resource share.</p>"
},
"associatedEntity":{
"shape":"String",
"documentation":"<p>The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.</p>"
@ -1075,7 +1137,7 @@
},
"external":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the principal belongs to the same organization as the AWS account that owns the resource share.</p>"
"documentation":"<p>Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.</p>"
}
},
"documentation":"<p>Describes an association with a resource share.</p>"
@ -1134,7 +1196,9 @@
},
"resourceShareAssociations":{
"shape":"ResourceShareAssociationList",
"documentation":"<p>The resources associated with the resource share.</p>"
"documentation":"<p>To view the resources associated with a pending resource share invitation, use <a href=\"https://docs.aws.amazon.com/ram/latest/APIReference/API_ListPendingInvitationResources.html\">ListPendingInvitationResources</a>.</p>",
"deprecated":true,
"deprecatedMessage":"This member has been deprecated. Use ListPendingInvitationResources."
}
},
"documentation":"<p>Describes an invitation to join a resource share.</p>"
@ -1226,7 +1290,8 @@
"AVAILABLE",
"ZONAL_RESOURCE_INACCESSIBLE",
"LIMIT_EXCEEDED",
"UNAVAILABLE"
"UNAVAILABLE",
"PENDING"
]
},
"ServerInternalException":{
@ -1301,6 +1366,16 @@
"type":"list",
"member":{"shape":"Tag"}
},
"TagPolicyViolationException":{
"type":"structure",
"required":["message"],
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The specified tag is a reserved word and cannot be used.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"TagResourceRequest":{
"type":"structure",
"required":[
@ -1374,7 +1449,7 @@
},
"allowExternalPrincipals":{
"shape":"Boolean",
"documentation":"<p>Indicates whether principals outside your organization can be associated with a resource share.</p>"
"documentation":"<p>Indicates whether principals outside your AWS organization can be associated with a resource share.</p>"
},
"clientToken":{
"shape":"String",
@ -1396,5 +1471,5 @@
}
}
},
"documentation":"<p>Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resource. The following principals are supported:</p> <ul> <li> <p>The ID of an AWS account</p> </li> <li> <p>The Amazon Resource Name (ARN) of an OU from AWS Organizations</p> </li> <li> <p>The Amazon Resource Name (ARN) of an organization from AWS Organizations</p> </li> </ul> <p>If you specify an AWS account that doesn't exist in the same organization as the account that owns the resource share, the owner of the specified account receives an invitation to accept the resource share. After the owner accepts the invitation, they can access the resources in the resource share. An administrator of the specified account can use IAM policies to restrict access resources in the resource share.</p>"
"documentation":"<p>Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/ram/latest/userguide/\">AWS Resource Access Manager User Guide</a>.</p>"
}

1570
botocore/data/rds-data/2018-08-01/service-2.json
View file

@ -1,908 +1,864 @@
{
"version": "2.0",
"metadata": {
"apiVersion": "2018-08-01",
"endpointPrefix": "rds-data",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceFullName": "AWS RDS DataService",
"serviceId": "RDS Data",
"signatureVersion": "v4",
"signingName": "rds-data",
"uid": "rds-data-2018-08-01"
"version":"2.0",
"metadata":{
"apiVersion":"2018-08-01",
"endpointPrefix":"rds-data",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS RDS DataService",
"serviceId":"RDS Data",
"signatureVersion":"v4",
"signingName":"rds-data",
"uid":"rds-data-2018-08-01"
},
"documentation": "<fullname>Amazon RDS Data Service</fullname>\n <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora\n Serverless DB cluster. To run these statements, you work with the Data Service\n API.</p>\n <p>For more information about the Data Service API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora\n Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>",
"operations": {
"BatchExecuteStatement": {
"name": "BatchExecuteStatement",
"http": {
"method": "POST",
"requestUri": "/BatchExecute",
"responseCode": 200
"operations":{
"BatchExecuteStatement":{
"name":"BatchExecuteStatement",
"http":{
"method":"POST",
"requestUri":"/BatchExecute",
"responseCode":200
},
"input": {
"shape": "BatchExecuteStatementRequest"
},
"output": {
"shape": "BatchExecuteStatementResponse"
},
"errors": [
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
{
"shape": "ServiceUnavailableError"
},
{
"shape": "StatementTimeoutException"
}
"input":{"shape":"BatchExecuteStatementRequest"},
"output":{"shape":"BatchExecuteStatementResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"StatementTimeoutException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"}
],
"documentation": "<p>Runs a batch SQL statement over an array of data.</p>\n <p>You can run bulk update and insert operations for multiple records using a DML \n statement with different parameter sets. Bulk operations can provide a significant \n performance improvement over individual insert and update operations.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p> \n </important>"
"documentation":"<p>Runs a batch SQL statement over an array of data.</p> <p>You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.</p> <important> <p>If a call isn't part of a transaction because it doesn't include the <code>transactionID</code> parameter, changes that result from the call are committed automatically.</p> </important>"
},
"BeginTransaction": {
"name": "BeginTransaction",
"http": {
"method": "POST",
"requestUri": "/BeginTransaction",
"responseCode": 200
"BeginTransaction":{
"name":"BeginTransaction",
"http":{
"method":"POST",
"requestUri":"/BeginTransaction",
"responseCode":200
},
"input": {
"shape": "BeginTransactionRequest"
},
"output": {
"shape": "BeginTransactionResponse"
},
"errors": [
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
{
"shape": "ServiceUnavailableError"
},
{
"shape": "StatementTimeoutException"
}
"input":{"shape":"BeginTransactionRequest"},
"output":{"shape":"BeginTransactionResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"StatementTimeoutException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"}
],
"documentation": "<p>Starts a SQL transaction.</p>\n \n <important>\n <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and \n rolled back automatically after 24 hours.</p>\n <p>A transaction times out if no calls use its transaction ID in three minutes. \n If a transaction times out before it's committed, it's rolled back\n automatically.</p>\n <p>DDL statements inside a transaction cause an implicit commit. We recommend \n that you run each DDL statement in a separate <code>ExecuteStatement</code> call with \n <code>continueAfterTimeout</code> enabled.</p>\n </important>"
"documentation":"<p>Starts a SQL transaction.</p> <pre><code> &lt;important&gt; &lt;p&gt;A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.&lt;/p&gt; &lt;p&gt;A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.&lt;/p&gt; &lt;p&gt;DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate &lt;code&gt;ExecuteStatement&lt;/code&gt; call with &lt;code&gt;continueAfterTimeout&lt;/code&gt; enabled.&lt;/p&gt; &lt;/important&gt; </code></pre>"
},
"CommitTransaction": {
"name": "CommitTransaction",
"http": {
"method": "POST",
"requestUri": "/CommitTransaction",
"responseCode": 200
"CommitTransaction":{
"name":"CommitTransaction",
"http":{
"method":"POST",
"requestUri":"/CommitTransaction",
"responseCode":200
},
"input": {
"shape": "CommitTransactionRequest"
},
"output": {
"shape": "CommitTransactionResponse"
},
"errors": [
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
{
"shape": "NotFoundException"
},
{
"shape": "ServiceUnavailableError"
}
"input":{"shape":"CommitTransactionRequest"},
"output":{"shape":"CommitTransactionResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"},
{"shape":"NotFoundException"}
],
"documentation": "<p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and\n commits the changes.</p>"
"documentation":"<p>Ends a SQL transaction started with the <code>BeginTransaction</code> operation and commits the changes.</p>"
},
"ExecuteSql": {
"name": "ExecuteSql",
"http": {
"method": "POST",
"requestUri": "/ExecuteSql",
"responseCode": 200
"ExecuteSql":{
"name":"ExecuteSql",
"http":{
"method":"POST",
"requestUri":"/ExecuteSql",
"responseCode":200
},
"input": {
"shape": "ExecuteSqlRequest"
},
"output": {
"shape": "ExecuteSqlResponse"
},
"errors": [
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
{
"shape": "ServiceUnavailableError"
}
"input":{"shape":"ExecuteSqlRequest"},
"output":{"shape":"ExecuteSqlResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"}
],
"deprecated": true,
"documentation": "<p>Runs one or more SQL statements.</p>\n <important>\n <p>This operation is deprecated. Use the <code>BatchExecuteStatement</code> or\n <code>ExecuteStatement</code> operation.</p>\n </important>"
"documentation":"<p>Runs one or more SQL statements.</p> <important> <p>This operation is deprecated. Use the <code>BatchExecuteStatement</code> or <code>ExecuteStatement</code> operation.</p> </important>",
"deprecated":true,
"deprecatedMessage":"The ExecuteSql API is deprecated, please use the ExecuteStatement API."
},
"ExecuteStatement": {
"name": "ExecuteStatement",
"http": {
"method": "POST",
"requestUri": "/Execute",
"responseCode": 200
"ExecuteStatement":{
"name":"ExecuteStatement",
"http":{
"method":"POST",
"requestUri":"/Execute",
"responseCode":200
},
"input": {
"shape": "ExecuteStatementRequest"
},
"output": {
"shape": "ExecuteStatementResponse"
},
"errors": [
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
{
"shape": "ServiceUnavailableError"
},
{
"shape": "StatementTimeoutException"
}
"input":{"shape":"ExecuteStatementRequest"},
"output":{"shape":"ExecuteStatementResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"StatementTimeoutException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"}
],
"documentation": "<p>Runs a SQL statement against a database.</p>\n <important> \n <p>If a call isn't part of a transaction because it doesn't include the\n <code>transactionID</code> parameter, changes that result from the call are\n committed automatically.</p> \n </important>\n <p>The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.</p>"
"documentation":"<p>Runs a SQL statement against a database.</p> <important> <p>If a call isn't part of a transaction because it doesn't include the <code>transactionID</code> parameter, changes that result from the call are committed automatically.</p> </important> <p>The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.</p>"
},
"RollbackTransaction": {
"name": "RollbackTransaction",
"http": {
"method": "POST",
"requestUri": "/RollbackTransaction",
"responseCode": 200
"RollbackTransaction":{
"name":"RollbackTransaction",
"http":{
"method":"POST",
"requestUri":"/RollbackTransaction",
"responseCode":200
},
"input": {
"shape": "RollbackTransactionRequest"
},
"output": {
"shape": "RollbackTransactionResponse"
},
"errors": [
{
"shape": "BadRequestException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "InternalServerErrorException"
},
{
"shape": "NotFoundException"
},
{
"shape": "ServiceUnavailableError"
}
"input":{"shape":"RollbackTransactionRequest"},
"output":{"shape":"RollbackTransactionResponse"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"InternalServerErrorException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableError"},
{"shape":"NotFoundException"}
],
"documentation": "<p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>"
"documentation":"<p>Performs a rollback of a transaction. Rolling back a transaction cancels its changes.</p>"
}
},
"shapes": {
"SqlStatementResults": {
"type": "list",
"member": {
"shape": "SqlStatementResult"
}
"shapes":{
"Arn":{
"type":"string",
"max":100,
"min":11
},
"ResultFrame": {
"type": "structure",
"members": {
"records": {
"shape": "Records",
"documentation": "<p>The records in the result set.</p>"
"ArrayOfArray":{
"type":"list",
"member":{"shape":"ArrayValue"},
"documentation":"<p>An array of arrays.</p> <note> <p>Some array entries can be null.</p> </note>"
},
"ArrayValue":{
"type":"structure",
"members":{
"arrayValues":{
"shape":"ArrayOfArray",
"documentation":"<p>An array of arrays.</p>"
},
"resultSetMetadata": {
"shape": "ResultSetMetadata",
"documentation": "<p>The result-set metadata in the result set.</p>"
"booleanValues":{
"shape":"BooleanArray",
"documentation":"<p>An array of Boolean values.</p>"
},
"doubleValues":{
"shape":"DoubleArray",
"documentation":"<p>An array of integers.</p>"
},
"longValues":{
"shape":"LongArray",
"documentation":"<p>An array of floating point numbers.</p>"
},
"stringValues":{
"shape":"StringArray",
"documentation":"<p>An array of strings.</p>"
}
},
"documentation": "<p>The result set returned by a SQL statement.</p>"
"documentation":"<p>Contains an array.</p>"
},
"SqlParameterSets": {
"type": "list",
"member": {
"shape": "SqlParametersList"
}
"ArrayValueList":{
"type":"list",
"member":{"shape":"Value"}
},
"NotFoundException": {
"type": "structure",
"members": {
"message": {
"shape": "ErrorMessage",
"documentation": "<p>The error message returned by this <code>NotFoundException</code> error.</p>"
"BadRequestException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned by this <code>BadRequestException</code> error.</p>"
}
},
"documentation": "<p>The <code>resourceArn</code>, <code>secretArn</code>, or <code>transactionId</code> value can't be found.</p>",
"exception": true,
"error": {
"code": "NotFoundException",
"httpStatusCode": 404,
"senderFault": true
}
"documentation":"<p>There is an error in the call or in a SQL statement.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"BatchExecuteStatementRequest": {
"type": "structure",
"required": [
"BatchExecuteStatementRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn",
"sql"
],
"members": {
"database": {
"shape": "DbName",
"documentation": "<p>The name of the database.</p>"
"members":{
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"parameterSets": {
"shape": "SqlParameterSets",
"documentation": "<p>The parameter set for the batch operation.</p>"
"parameterSets":{
"shape":"SqlParameterSets",
"documentation":"<p>The parameter set for the batch operation.</p>"
},
"resourceArn": {
"shape": "Arn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"schema": {
"shape": "DbName",
"documentation": "<p>The name of the database schema.</p>"
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"secretArn": {
"shape": "Arn",
"documentation": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
"secretArn":{
"shape":"Arn",
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
},
"sql": {
"shape": "SqlStatement",
"documentation": "<p>The SQL statement to run.</p>"
"sql":{
"shape":"SqlStatement",
"documentation":"<p>The SQL statement to run.</p>"
},
"transactionId": {
"shape": "Id",
"documentation": "<p>The identifier of a transaction that was started by using the\n <code>BeginTransaction</code> operation. Specify the transaction ID of the\n transaction that you want to include the SQL statement in.</p>\n <p>If the SQL statement is not part of a transaction, don't set this\n parameter.</p>"
"transactionId":{
"shape":"Id",
"documentation":"<p>The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.</p> <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>"
}
},
"documentation": "<p>The request parameters represent the input of a SQL statement over an array of\n data.</p>"
"documentation":"<p>The request parameters represent the input of a SQL statement over an array of data.</p>"
},
"ArrayValueList": {
"type": "list",
"member": {
"shape": "Value"
}
},
"UpdateResults": {
"type": "list",
"member": {
"shape": "UpdateResult"
}
},
"Row": {
"type": "list",
"member": {
"shape": "Value"
}
},
"SqlRecords": {
"type": "list",
"member": {
"shape": "FieldList"
}
},
"Long": {
"type": "long"
},
"BoxedInteger": {
"type": "integer",
"box": true
},
"CommitTransactionResponse": {
"type": "structure",
"members": {
"transactionStatus": {
"shape": "TransactionStatus",
"documentation": "<p>The status of the commit operation.</p>"
"BatchExecuteStatementResponse":{
"type":"structure",
"members":{
"updateResults":{
"shape":"UpdateResults",
"documentation":"<p>The execution results of each batch entry.</p>"
}
},
"documentation": "<p>The response elements represent the output of a commit transaction request.</p>"
"documentation":"<p>The response elements represent the output of a SQL statement over an array of data.</p>"
},
"Integer": {
"type": "integer"
},
"BoxedLong": {
"type": "long",
"box": true
},
"SqlParameter": {
"type": "structure",
"members": {
"name": {
"shape": "ParameterName",
"documentation": "<p>The name of the parameter.</p>"
"BeginTransactionRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn"
],
"members":{
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"value": {
"shape": "Field",
"documentation": "<p>The value of the parameter.</p>"
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"secretArn":{
"shape":"Arn",
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
}
},
"documentation": "<p>A parameter used in a SQL statement.</p>"
"documentation":"<p>The request parameters represent the input of a request to start a SQL transaction.</p>"
},
"Field": {
"type": "structure",
"members": {
"blobValue": {
"shape": "Blob",
"documentation": "<p>A value of BLOB data type.</p>"
},
"booleanValue": {
"shape": "BoxedBoolean",
"documentation": "<p>A value of Boolean data type.</p>"
},
"doubleValue": {
"shape": "BoxedDouble",
"documentation": "<p>A value of double data type.</p>"
},
"isNull": {
"shape": "BoxedBoolean",
"documentation": "<p>A NULL value.</p>"
},
"longValue": {
"shape": "BoxedLong",
"documentation": "<p>A value of long data type.</p>"
},
"stringValue": {
"shape": "String",
"documentation": "<p>A value of string data type.</p>"
"BeginTransactionResponse":{
"type":"structure",
"members":{
"transactionId":{
"shape":"Id",
"documentation":"<p>The transaction ID of the transaction started by the call.</p>"
}
},
"documentation": "<p>Contains a value.</p>"
"documentation":"<p>The response elements represent the output of a request to start a SQL transaction.</p>"
},
"ExecuteSqlRequest": {
"type": "structure",
"required": [
"Blob":{"type":"blob"},
"Boolean":{"type":"boolean"},
"BooleanArray":{
"type":"list",
"member":{"shape":"BoxedBoolean"},
"documentation":"<p>An array of Boolean values.</p> <note> <p>Some array entries can be null.</p> </note>"
},
"BoxedBoolean":{
"type":"boolean",
"box":true
},
"BoxedDouble":{
"type":"double",
"box":true
},
"BoxedFloat":{
"type":"float",
"box":true
},
"BoxedInteger":{
"type":"integer",
"box":true
},
"BoxedLong":{
"type":"long",
"box":true
},
"ColumnMetadata":{
"type":"structure",
"members":{
"arrayBaseColumnType":{
"shape":"Integer",
"documentation":"<p>The type of the column.</p>"
},
"isAutoIncrement":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether the column increments automatically.</p>"
},
"isCaseSensitive":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether the column is case-sensitive.</p>"
},
"isCurrency":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether the column contains currency values.</p>"
},
"isSigned":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether an integer column is signed.</p>"
},
"label":{
"shape":"String",
"documentation":"<p>The label for the column.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the column.</p>"
},
"nullable":{
"shape":"Integer",
"documentation":"<p>A value that indicates whether the column is nullable.</p>"
},
"precision":{
"shape":"Integer",
"documentation":"<p>The precision value of a decimal number column.</p>"
},
"scale":{
"shape":"Integer",
"documentation":"<p>The scale value of a decimal number column.</p>"
},
"schemaName":{
"shape":"String",
"documentation":"<p>The name of the schema that owns the table that includes the column.</p>"
},
"tableName":{
"shape":"String",
"documentation":"<p>The name of the table that includes the column.</p>"
},
"type":{
"shape":"Integer",
"documentation":"<p>The type of the column.</p>"
},
"typeName":{
"shape":"String",
"documentation":"<p>The database-specific data type of the column.</p>"
}
},
"documentation":"<p>Contains the metadata for a column.</p>"
},
"CommitTransactionRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn",
"transactionId"
],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"secretArn":{
"shape":"Arn",
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
},
"transactionId":{
"shape":"Id",
"documentation":"<p>The identifier of the transaction to end and commit.</p>"
}
},
"documentation":"<p>The request parameters represent the input of a commit transaction request.</p>"
},
"CommitTransactionResponse":{
"type":"structure",
"members":{
"transactionStatus":{
"shape":"TransactionStatus",
"documentation":"<p>The status of the commit operation.</p>"
}
},
"documentation":"<p>The response elements represent the output of a commit transaction request.</p>"
},
"DbName":{
"type":"string",
"max":64,
"min":0
},
"DecimalReturnType":{
"type":"string",
"enum":[
"DOUBLE_OR_LONG",
"STRING"
]
},
"DoubleArray":{
"type":"list",
"member":{"shape":"BoxedDouble"},
"documentation":"<p>An array of floating point numbers.</p> <note> <p>Some array entries can be null.</p> </note>"
},
"ErrorMessage":{"type":"string"},
"ExecuteSqlRequest":{
"type":"structure",
"required":[
"awsSecretStoreArn",
"dbClusterOrInstanceArn",
"sqlStatements"
],
"members": {
"awsSecretStoreArn": {
"shape": "Arn",
"documentation": "<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.</p>"
"members":{
"awsSecretStoreArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.</p>"
},
"database": {
"shape": "DbName",
"documentation": "<p>The name of the database.</p>"
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"dbClusterOrInstanceArn": {
"shape": "Arn",
"documentation": "<p>The ARN of the Aurora Serverless DB cluster.</p>"
"dbClusterOrInstanceArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the Aurora Serverless DB cluster.</p>"
},
"schema": {
"shape": "DbName",
"documentation": "<p>The name of the database schema.</p>"
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"sqlStatements": {
"shape": "SqlStatement",
"documentation": "<p>One or more SQL statements to run on the DB cluster.</p>\n <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL\n statement is permitted, including data definition, data manipulation, and commit\n statements. </p>"
"sqlStatements":{
"shape":"SqlStatement",
"documentation":"<p>One or more SQL statements to run on the DB cluster.</p> <p>You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements. </p>"
}
},
"documentation": "<p>The request parameters represent the input of a request to run one or more SQL\n statements.</p>"
"documentation":"<p>The request parameters represent the input of a request to run one or more SQL statements.</p>"
},
"Arn": {
"type": "string",
"max": 100
},
"StructValue": {
"type": "structure",
"members": {
"attributes": {
"shape": "ArrayValueList",
"documentation": "<p>The attributes returned in the record.</p>"
"ExecuteSqlResponse":{
"type":"structure",
"members":{
"sqlStatementResults":{
"shape":"SqlStatementResults",
"documentation":"<p>The results of the SQL statement or statements.</p>"
}
},
"documentation": "<p>A structure value returned by a call.</p>"
"documentation":"<p>The response elements represent the output of a request to run one or more SQL statements.</p>"
},
"Boolean": {
"type": "boolean"
},
"BadRequestException": {
"type": "structure",
"members": {
"message": {
"shape": "ErrorMessage",
"documentation": "<p>The error message returned by this <code>BadRequestException</code> error.</p>"
}
},
"documentation": "<p>There is an error in the call or in a SQL statement.</p>",
"exception": true,
"error": {
"code": "BadRequestException",
"httpStatusCode": 400,
"senderFault": true
}
},
"TransactionStatus": {
"type": "string",
"max": 128
},
"SqlStatement": {
"type": "string",
"max": 65536
},
"RollbackTransactionRequest": {
"type": "structure",
"required": [
"resourceArn",
"secretArn",
"transactionId"
],
"members": {
"resourceArn": {
"shape": "Arn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"secretArn": {
"shape": "Arn",
"documentation": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
},
"transactionId": {
"shape": "Id",
"documentation": "<p>The identifier of the transaction to roll back.</p>"
}
},
"documentation": "<p>The request parameters represent the input of a request to perform a rollback of a\n transaction.</p>"
},
"ErrorMessage": {
"type": "string"
},
"Record": {
"type": "structure",
"members": {
"values": {
"shape": "Row",
"documentation": "<p>The values returned in the record.</p>"
}
},
"documentation": "<p>A record returned by a call.</p>"
},
"BoxedFloat": {
"type": "float",
"box": true
},
"BoxedDouble": {
"type": "double",
"box": true
},
"ForbiddenException": {
"type": "structure",
"members": {
"message": {
"shape": "ErrorMessage",
"documentation": "<p>The error message returned by this <code>ForbiddenException</code> error.</p>"
}
},
"documentation": "<p>There are insufficient privileges to make the call.</p>",
"exception": true,
"error": {
"code": "ForbiddenException",
"httpStatusCode": 403,
"senderFault": true
}
},
"Value": {
"type": "structure",
"members": {
"arrayValues": {
"shape": "ArrayValueList",
"documentation": "<p>An array of column values.</p>"
},
"bigIntValue": {
"shape": "BoxedLong",
"documentation": "<p>A value for a column of big integer data type.</p>"
},
"bitValue": {
"shape": "BoxedBoolean",
"documentation": "<p>A value for a column of BIT data type.</p>"
},
"blobValue": {
"shape": "Blob",
"documentation": "<p>A value for a column of BLOB data type.</p>"
},
"doubleValue": {
"shape": "BoxedDouble",
"documentation": "<p>A value for a column of double data type.</p>"
},
"intValue": {
"shape": "BoxedInteger",
"documentation": "<p>A value for a column of integer data type.</p>"
},
"isNull": {
"shape": "BoxedBoolean",
"documentation": "<p>A NULL value.</p>"
},
"realValue": {
"shape": "BoxedFloat",
"documentation": "<p>A value for a column of real data type.</p>"
},
"stringValue": {
"shape": "String",
"documentation": "<p>A value for a column of string data type.</p>"
},
"structValue": {
"shape": "StructValue",
"documentation": "<p>A value for a column of STRUCT data type.</p>"
}
},
"documentation": "<p>Contains the value of a column.</p>"
},
"FieldList": {
"type": "list",
"member": {
"shape": "Field"
}
},
"StatementTimeoutException": {
"type": "structure",
"members": {
"dbConnectionId": {
"shape": "Long",
"documentation": "<p>The database connection ID that executed the SQL statement.</p>"
},
"message": {
"shape": "ErrorMessage",
"documentation": "<p>The error message returned by this <code>StatementTimeoutException</code> error.</p>"
}
},
"documentation": "<p>The execution of the SQL statement timed out.</p>",
"exception": true,
"error": {
"code": "StatementTimeoutException",
"httpStatusCode": 400,
"senderFault": true
}
},
"ExecuteStatementResponse": {
"type": "structure",
"members": {
"columnMetadata": {
"shape": "Metadata",
"documentation": "<p>Metadata for the columns included in the results.</p>"
},
"generatedFields": {
"shape": "FieldList",
"documentation": "<p>Values for fields generated during the request.</p>"
},
"numberOfRecordsUpdated": {
"shape": "RecordsUpdated",
"documentation": "<p>The number of records updated by the request.</p>"
},
"records": {
"shape": "SqlRecords",
"documentation": "<p>The records returned by the SQL statement.</p>"
}
},
"documentation": "<p>The response elements represent the output of a request to run a SQL statement against\n a database.</p>"
},
"BoxedBoolean": {
"type": "boolean",
"box": true
},
"RecordsUpdated": {
"type": "long"
},
"UpdateResult": {
"type": "structure",
"members": {
"generatedFields": {
"shape": "FieldList",
"documentation": "<p>Values for fields generated during the request.</p>"
}
},
"documentation": "<p>The response elements represent the results of an update.</p>"
},
"SqlParametersList": {
"type": "list",
"member": {
"shape": "SqlParameter"
}
},
"ParameterName": {
"type": "string"
},
"Metadata": {
"type": "list",
"member": {
"shape": "ColumnMetadata"
}
},
"ExecuteSqlResponse": {
"type": "structure",
"members": {
"sqlStatementResults": {
"shape": "SqlStatementResults",
"documentation": "<p>The results of the SQL statement or statements.</p>"
}
},
"documentation": "<p>The response elements represent the output of a request to run one or more SQL\n statements.</p>"
},
"SqlStatementResult": {
"type": "structure",
"members": {
"numberOfRecordsUpdated": {
"shape": "RecordsUpdated",
"documentation": "<p>The number of records updated by a SQL statement.</p>"
},
"resultFrame": {
"shape": "ResultFrame",
"documentation": "<p>The result set of the SQL statement.</p>"
}
},
"documentation": "<p>The result of a SQL statement.</p>"
},
"BeginTransactionRequest": {
"type": "structure",
"required": [
"resourceArn",
"secretArn"
],
"members": {
"database": {
"shape": "DbName",
"documentation": "<p>The name of the database.</p>"
},
"resourceArn": {
"shape": "Arn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"schema": {
"shape": "DbName",
"documentation": "<p>The name of the database schema.</p>"
},
"secretArn": {
"shape": "Arn",
"documentation": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
}
},
"documentation": "<p>The request parameters represent the input of a request to start a SQL\n transaction.</p>"
},
"RollbackTransactionResponse": {
"type": "structure",
"members": {
"transactionStatus": {
"shape": "TransactionStatus",
"documentation": "<p>The status of the rollback operation.</p>"
}
},
"documentation": "<p>The response elements represent the output of a request to perform a rollback of a\n transaction.</p>"
},
"BatchExecuteStatementResponse": {
"type": "structure",
"members": {
"updateResults": {
"shape": "UpdateResults",
"documentation": "<p>The execution results of each batch entry.</p>"
}
},
"documentation": "<p>The response elements represent the output of a SQL statement over an array of\n data.</p>"
},
"ResultSetMetadata": {
"type": "structure",
"members": {
"columnCount": {
"shape": "Long",
"documentation": "<p>The number of columns in the result set.</p>"
},
"columnMetadata": {
"shape": "Metadata",
"documentation": "<p>The metadata of the columns in the result set.</p>"
}
},
"documentation": "<p>The metadata of the result set returned by a SQL statement.</p>"
},
"Records": {
"type": "list",
"member": {
"shape": "Record"
}
},
"ExecuteStatementRequest": {
"type": "structure",
"required": [
"ExecuteStatementRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn",
"sql"
],
"members": {
"continueAfterTimeout": {
"shape": "Boolean",
"documentation": "<p>A value that indicates whether to continue running the statement after \n the call times out. By default, the statement stops running when the call \n times out.</p>\n <important>\n <p>For DDL statements, we recommend continuing to run the statement after \n the call times out. When a DDL statement terminates before it is finished \n running, it can result in errors and possibly corrupted data structures.</p>\n </important>"
"members":{
"continueAfterTimeout":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.</p> <important> <p>For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.</p> </important>"
},
"database": {
"shape": "DbName",
"documentation": "<p>The name of the database.</p>"
"database":{
"shape":"DbName",
"documentation":"<p>The name of the database.</p>"
},
"includeResultMetadata": {
"shape": "Boolean",
"documentation": "<p>A value that indicates whether to include metadata in the results.</p>"
"includeResultMetadata":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether to include metadata in the results.</p>"
},
"parameters": {
"shape": "SqlParametersList",
"documentation": "<p>The parameters for the SQL statement.</p>"
"parameters":{
"shape":"SqlParametersList",
"documentation":"<p>The parameters for the SQL statement.</p>"
},
"resourceArn": {
"shape": "Arn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"schema": {
"shape": "DbName",
"documentation": "<p>The name of the database schema.</p>"
"resultSetOptions":{
"shape":"ResultSetOptions",
"documentation":"<p>Options that control how the result set is returned.</p>"
},
"secretArn": {
"shape": "Arn",
"documentation": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
"schema":{
"shape":"DbName",
"documentation":"<p>The name of the database schema.</p>"
},
"sql": {
"shape": "SqlStatement",
"documentation": "<p>The SQL statement to run.</p>"
"secretArn":{
"shape":"Arn",
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
},
"transactionId": {
"shape": "Id",
"documentation": "<p>The identifier of a transaction that was started by using the\n <code>BeginTransaction</code> operation. Specify the transaction ID of the\n transaction that you want to include the SQL statement in.</p>\n <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>"
"sql":{
"shape":"SqlStatement",
"documentation":"<p>The SQL statement to run.</p>"
},
"transactionId":{
"shape":"Id",
"documentation":"<p>The identifier of a transaction that was started by using the <code>BeginTransaction</code> operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.</p> <p>If the SQL statement is not part of a transaction, don't set this parameter.</p>"
}
},
"documentation": "<p>The request parameters represent the input of a request to run a SQL statement against\n a database.</p>"
"documentation":"<p>The request parameters represent the input of a request to run a SQL statement against a database.</p>"
},
"Blob": {
"type": "blob"
},
"String": {
"type": "string"
},
"BeginTransactionResponse": {
"type": "structure",
"members": {
"transactionId": {
"shape": "Id",
"documentation": "<p>The transaction ID of the transaction started by the call.</p>"
"ExecuteStatementResponse":{
"type":"structure",
"members":{
"columnMetadata":{
"shape":"Metadata",
"documentation":"<p>Metadata for the columns included in the results.</p>"
},
"generatedFields":{
"shape":"FieldList",
"documentation":"<p>Values for fields generated during the request.</p> <pre><code> &lt;note&gt; &lt;p&gt;The &lt;code&gt;generatedFields&lt;/code&gt; data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the &lt;code&gt;RETURNING&lt;/code&gt; clause. For more information, see &lt;a href=&quot;https://www.postgresql.org/docs/10/dml-returning.html&quot;&gt;Returning Data From Modified Rows&lt;/a&gt; in the PostgreSQL documentation.&lt;/p&gt; &lt;/note&gt; </code></pre>"
},
"numberOfRecordsUpdated":{
"shape":"RecordsUpdated",
"documentation":"<p>The number of records updated by the request.</p>"
},
"records":{
"shape":"SqlRecords",
"documentation":"<p>The records returned by the SQL statement.</p>"
}
},
"documentation": "<p>The response elements represent the output of a request to start a SQL\n transaction.</p>"
"documentation":"<p>The response elements represent the output of a request to run a SQL statement against a database.</p>"
},
"Id": {
"type": "string",
"max": 192
"Field":{
"type":"structure",
"members":{
"arrayValue":{
"shape":"ArrayValue",
"documentation":"<p>An array of values.</p>"
},
"blobValue":{
"shape":"Blob",
"documentation":"<p>A value of BLOB data type.</p>"
},
"booleanValue":{
"shape":"BoxedBoolean",
"documentation":"<p>A value of Boolean data type.</p>"
},
"doubleValue":{
"shape":"BoxedDouble",
"documentation":"<p>A value of double data type.</p>"
},
"isNull":{
"shape":"BoxedBoolean",
"documentation":"<p>A NULL value.</p>"
},
"longValue":{
"shape":"BoxedLong",
"documentation":"<p>A value of long data type.</p>"
},
"stringValue":{
"shape":"String",
"documentation":"<p>A value of string data type.</p>"
}
},
"documentation":"<p>Contains a value.</p>"
},
"CommitTransactionRequest": {
"type": "structure",
"required": [
"FieldList":{
"type":"list",
"member":{"shape":"Field"}
},
"ForbiddenException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned by this <code>ForbiddenException</code> error.</p>"
}
},
"documentation":"<p>There are insufficient privileges to make the call.</p>",
"error":{
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"Id":{
"type":"string",
"max":192,
"min":0
},
"Integer":{"type":"integer"},
"InternalServerErrorException":{
"type":"structure",
"members":{
},
"documentation":"<p>An internal error occurred.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"Long":{"type":"long"},
"LongArray":{
"type":"list",
"member":{"shape":"BoxedLong"},
"documentation":"<p>An array of integers.</p> <note> <p>Some array entries can be null.</p> </note>"
},
"Metadata":{
"type":"list",
"member":{"shape":"ColumnMetadata"}
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned by this <code>NotFoundException</code> error.</p>"
}
},
"documentation":"<p>The <code>resourceArn</code>, <code>secretArn</code>, or <code>transactionId</code> value can't be found.</p>",
"error":{
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"ParameterName":{"type":"string"},
"Record":{
"type":"structure",
"members":{
"values":{
"shape":"Row",
"documentation":"<p>The values returned in the record.</p>"
}
},
"documentation":"<p>A record returned by a call.</p>"
},
"Records":{
"type":"list",
"member":{"shape":"Record"}
},
"RecordsUpdated":{"type":"long"},
"ResultFrame":{
"type":"structure",
"members":{
"records":{
"shape":"Records",
"documentation":"<p>The records in the result set.</p>"
},
"resultSetMetadata":{
"shape":"ResultSetMetadata",
"documentation":"<p>The result-set metadata in the result set.</p>"
}
},
"documentation":"<p>The result set returned by a SQL statement.</p>"
},
"ResultSetMetadata":{
"type":"structure",
"members":{
"columnCount":{
"shape":"Long",
"documentation":"<p>The number of columns in the result set.</p>"
},
"columnMetadata":{
"shape":"Metadata",
"documentation":"<p>The metadata of the columns in the result set.</p>"
}
},
"documentation":"<p>The metadata of the result set returned by a SQL statement.</p>"
},
"ResultSetOptions":{
"type":"structure",
"members":{
"decimalReturnType":{
"shape":"DecimalReturnType",
"documentation":"<p>A value that indicates how a field of <code>DECIMAL</code> type is represented in the response. The value of <code>STRING</code>, the default, specifies that it is converted to a String value. The value of <code>DOUBLE_OR_LONG</code> specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.</p> <important> <p>Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.</p> </important>"
}
},
"documentation":"<p>Options that control how the result set is returned.</p>"
},
"RollbackTransactionRequest":{
"type":"structure",
"required":[
"resourceArn",
"secretArn",
"transactionId"
],
"members": {
"resourceArn": {
"shape": "Arn",
"documentation": "<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.</p>"
},
"secretArn": {
"shape": "Arn",
"documentation": "<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
"secretArn":{
"shape":"Arn",
"documentation":"<p>The name or ARN of the secret that enables access to the DB cluster.</p>"
},
"transactionId": {
"shape": "Id",
"documentation": "<p>The identifier of the transaction to end and commit.</p>"
"transactionId":{
"shape":"Id",
"documentation":"<p>The identifier of the transaction to roll back.</p>"
}
},
"documentation": "<p>The request parameters represent the input of a commit transaction request.</p>"
"documentation":"<p>The request parameters represent the input of a request to perform a rollback of a transaction.</p>"
},
"ServiceUnavailableError": {
"type": "structure",
"members": { },
"documentation": "<p>The service specified by the <code>resourceArn</code> parameter is not\n available.</p>",
"exception": true,
"error": {
"code": "ServiceUnavailableError",
"httpStatusCode": 503,
"fault": true
}
},
"ColumnMetadata": {
"type": "structure",
"members": {
"arrayBaseColumnType": {
"shape": "Integer",
"documentation": "<p>The type of the column.</p>"
},
"isAutoIncrement": {
"shape": "Boolean",
"documentation": "<p>A value that indicates whether the column increments automatically.</p>"
},
"isCaseSensitive": {
"shape": "Boolean",
"documentation": "<p>A value that indicates whether the column is case-sensitive.</p>"
},
"isCurrency": {
"shape": "Boolean",
"documentation": "<p>A value that indicates whether the column contains currency values.</p>"
},
"isSigned": {
"shape": "Boolean",
"documentation": "<p>A value that indicates whether an integer column is signed.</p>"
},
"label": {
"shape": "String",
"documentation": "<p>The label for the column.</p>"
},
"name": {
"shape": "String",
"documentation": "<p>The name of the column.</p>"
},
"nullable": {
"shape": "Integer",
"documentation": "<p>A value that indicates whether the column is nullable.</p>"
},
"precision": {
"shape": "Integer",
"documentation": "<p>The precision value of a decimal number column.</p>"
},
"scale": {
"shape": "Integer",
"documentation": "<p>The scale value of a decimal number column.</p>"
},
"schemaName": {
"shape": "String",
"documentation": "<p>The name of the schema that owns the table that includes the column.</p>"
},
"tableName": {
"shape": "String",
"documentation": "<p>The name of the table that includes the column.</p>"
},
"type": {
"shape": "Integer",
"documentation": "<p>The type of the column.</p>"
},
"typeName": {
"shape": "String",
"documentation": "<p>The database-specific data type of the column.</p>"
"RollbackTransactionResponse":{
"type":"structure",
"members":{
"transactionStatus":{
"shape":"TransactionStatus",
"documentation":"<p>The status of the rollback operation.</p>"
}
},
"documentation": "<p>Contains the metadata for a column.</p>"
"documentation":"<p>The response elements represent the output of a request to perform a rollback of a transaction.</p>"
},
"DbName": {
"type": "string",
"max": 64
"Row":{
"type":"list",
"member":{"shape":"Value"}
},
"InternalServerErrorException": {
"type": "structure",
"members": { },
"documentation": "<p>An internal error occurred.</p>",
"exception": true,
"error": {
"code": "InternalServerErrorException",
"httpStatusCode": 500,
"fault": true
}
"ServiceUnavailableError":{
"type":"structure",
"members":{
},
"documentation":"<p>The service specified by the <code>resourceArn</code> parameter is not available.</p>",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true
},
"SqlParameter":{
"type":"structure",
"members":{
"name":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter.</p>"
},
"value":{
"shape":"Field",
"documentation":"<p>The value of the parameter.</p>"
}
},
"documentation":"<p>A parameter used in a SQL statement.</p>"
},
"SqlParameterSets":{
"type":"list",
"member":{"shape":"SqlParametersList"}
},
"SqlParametersList":{
"type":"list",
"member":{"shape":"SqlParameter"}
},
"SqlRecords":{
"type":"list",
"member":{"shape":"FieldList"}
},
"SqlStatement":{
"type":"string",
"max":65536,
"min":0
},
"SqlStatementResult":{
"type":"structure",
"members":{
"numberOfRecordsUpdated":{
"shape":"RecordsUpdated",
"documentation":"<p>The number of records updated by a SQL statement.</p>"
},
"resultFrame":{
"shape":"ResultFrame",
"documentation":"<p>The result set of the SQL statement.</p>"
}
},
"documentation":"<p>The result of a SQL statement.</p> <pre><code> &lt;important&gt; &lt;p&gt;This data type is deprecated.&lt;/p&gt; &lt;/important&gt; </code></pre>"
},
"SqlStatementResults":{
"type":"list",
"member":{"shape":"SqlStatementResult"}
},
"StatementTimeoutException":{
"type":"structure",
"members":{
"dbConnectionId":{
"shape":"Long",
"documentation":"<p>The database connection ID that executed the SQL statement.</p>"
},
"message":{
"shape":"ErrorMessage",
"documentation":"<p>The error message returned by this <code>StatementTimeoutException</code> error.</p>"
}
},
"documentation":"<p>The execution of the SQL statement timed out.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"String":{"type":"string"},
"StringArray":{
"type":"list",
"member":{"shape":"String"},
"documentation":"<p>An array of strings.</p> <note> <p>Some array entries can be null.</p> </note>"
},
"StructValue":{
"type":"structure",
"members":{
"attributes":{
"shape":"ArrayValueList",
"documentation":"<p>The attributes returned in the record.</p>"
}
},
"documentation":"<p>A structure value returned by a call.</p>"
},
"TransactionStatus":{
"type":"string",
"max":128,
"min":0
},
"UpdateResult":{
"type":"structure",
"members":{
"generatedFields":{
"shape":"FieldList",
"documentation":"<p>Values for fields generated during the request.</p>"
}
},
"documentation":"<p>The response elements represent the results of an update.</p>"
},
"UpdateResults":{
"type":"list",
"member":{"shape":"UpdateResult"}
},
"Value":{
"type":"structure",
"members":{
"arrayValues":{
"shape":"ArrayValueList",
"documentation":"<p>An array of column values.</p>"
},
"bigIntValue":{
"shape":"BoxedLong",
"documentation":"<p>A value for a column of big integer data type.</p>"
},
"bitValue":{
"shape":"BoxedBoolean",
"documentation":"<p>A value for a column of BIT data type.</p>"
},
"blobValue":{
"shape":"Blob",
"documentation":"<p>A value for a column of BLOB data type.</p>"
},
"doubleValue":{
"shape":"BoxedDouble",
"documentation":"<p>A value for a column of double data type.</p>"
},
"intValue":{
"shape":"BoxedInteger",
"documentation":"<p>A value for a column of integer data type.</p>"
},
"isNull":{
"shape":"BoxedBoolean",
"documentation":"<p>A NULL value.</p>"
},
"realValue":{
"shape":"BoxedFloat",
"documentation":"<p>A value for a column of real data type.</p>"
},
"stringValue":{
"shape":"String",
"documentation":"<p>A value for a column of string data type.</p>"
},
"structValue":{
"shape":"StructValue",
"documentation":"<p>A value for a column of STRUCT data type.</p>"
}
},
"documentation":"<p>Contains the value of a column.</p> <pre><code> &lt;important&gt; &lt;p&gt;This data type is deprecated.&lt;/p&gt; &lt;/important&gt; </code></pre>"
}
}
},
"documentation":"<p><fullname>Amazon RDS Data Service</fullname> <p>Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API.</p> <p>For more information about the Data Service API, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>If you have questions or comments related to the Data API, send email to <a href=\"mailto:Rds-data-api-feedback@amazon.com\">Rds-data-api-feedback@amazon.com</a>.</p> </note></p>"
}

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

@ -250,7 +250,8 @@
{"shape":"DBInstanceNotFoundFault"},
{"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"},
{"shape":"GlobalClusterNotFoundFault"},
{"shape":"InvalidGlobalClusterStateFault"}
{"shape":"InvalidGlobalClusterStateFault"},
{"shape":"DomainNotFoundFault"}
],
"documentation":"<p>Creates a new Amazon Aurora DB cluster.</p> <p>You can use the <code>ReplicationSourceIdentifier</code> parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by <code>ReplicationSourceIdentifier</code> is encrypted, you must also specify the <code>PreSignedUrl</code> parameter.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
@ -375,7 +376,8 @@
{"shape":"DBSubnetGroupNotAllowedFault"},
{"shape":"InvalidDBSubnetGroupFault"},
{"shape":"StorageTypeNotSupportedFault"},
{"shape":"KMSKeyNotAccessibleFault"}
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DomainNotFoundFault"}
],
"documentation":"<p>Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html\">Working with Read Replicas</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Amazon Aurora doesn't support this action. You must call the <code>CreateDBInstance</code> action to create a DB instance for an Aurora DB cluster. </p> <p>All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following. </p> <important> <p>Your source DB instance must have backup retention enabled. </p> </important>"
},
@ -1317,7 +1319,8 @@
{"shape":"DBClusterParameterGroupNotFoundFault"},
{"shape":"InvalidDBSecurityGroupStateFault"},
{"shape":"InvalidDBInstanceStateFault"},
{"shape":"DBClusterAlreadyExistsFault"}
{"shape":"DBClusterAlreadyExistsFault"},
{"shape":"DomainNotFoundFault"}
],
"documentation":"<p>Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
@ -1738,6 +1741,7 @@
{"shape":"DBClusterParameterGroupNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DBClusterNotFoundFault"},
{"shape":"DomainNotFoundFault"},
{"shape":"InsufficientStorageClusterCapacityFault"}
],
"documentation":"<p>Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.html\"> Migrating Data to an Amazon Aurora MySQL DB Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
@ -1771,6 +1775,7 @@
{"shape":"InvalidSubnet"},
{"shape":"OptionGroupNotFoundFault"},
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"DomainNotFoundFault"},
{"shape":"DBClusterParameterGroupNotFoundFault"}
],
"documentation":"<p>Creates a new DB cluster from a DB snapshot or DB cluster snapshot.</p> <p>If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.</p> <p>If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
@ -1803,6 +1808,7 @@
{"shape":"KMSKeyNotAccessibleFault"},
{"shape":"OptionGroupNotFoundFault"},
{"shape":"StorageQuotaExceededFault"},
{"shape":"DomainNotFoundFault"},
{"shape":"DBClusterParameterGroupNotFoundFault"}
],
"documentation":"<p>Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before <code>LatestRestorableTime</code> for up to <code>BackupRetentionPeriod</code> days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. </p> <note> <p>This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the <code>CreateDBInstance</code> action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB cluster is available.</p> </note> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
@ -2671,7 +2677,7 @@
},
"EndpointType":{
"shape":"String",
"documentation":"<p>The type of the endpoint. One of: <code>READER</code>, <code>ANY</code>. </p>"
"documentation":"<p>The type of the endpoint. One of: <code>READER</code>, <code>WRITER</code>, <code>ANY</code>.</p>"
},
"StaticMembers":{
"shape":"StringList",
@ -2728,7 +2734,7 @@
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to use.</p> <p> <b>Aurora MySQL</b> </p> <p>Example: <code>5.6.10a</code>, <code>5.7.12</code> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Example: <code>9.6.3</code> </p>"
"documentation":"<p>The version number of the database engine to use.</p> <p>To list all of the available engine versions for <code>aurora</code> (for MySQL 5.6-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-postgresql</code>, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p> <b>Aurora MySQL</b> </p> <p>Example: <code>5.6.10a</code>, <code>5.6.mysql_aurora.1.19.2</code>, <code>5.7.12</code>, <code>5.7.mysql_aurora.2.04.5</code> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Example: <code>9.6.3</code>, <code>10.7</code> </p>"
},
"Port":{
"shape":"IntegerOptional",
@ -2776,7 +2782,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
@ -2788,7 +2794,7 @@
},
"EngineMode":{
"shape":"String",
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, or <code>global</code>.</p>"
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>"
},
"ScalingConfiguration":{
"shape":"ScalingConfiguration",
@ -2802,6 +2808,10 @@
"shape":"String",
"documentation":"<p> The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. </p>"
},
"EnableHttpEndpoint":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.</p> <p>When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html\">Using the Data API for Aurora Serverless</a> in the <i>Amazon Aurora User Guide</i>.</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.</p>"
@ -2934,7 +2944,7 @@
},
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
"documentation":"<p>The name of the DB parameter group to associate with this DB instance. If you do not specify a value for <code>DBParameterGroupName</code>, then the default <code>DBParameterGroup</code> for the specified DB engine is used.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
@ -2966,7 +2976,7 @@
},
"Iops":{
"shape":"IntegerOptional",
"documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance. </p>"
"documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide</i>. </p> <p>Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance. </p>"
},
"OptionGroupName":{
"shape":"String",
@ -3010,7 +3020,7 @@
},
"Domain":{
"shape":"String",
"documentation":"<p>For an Amazon RDS DB instance that's running Microsoft SQL Server, this parameter specifies the Active Directory directory ID to create the instance in. Amazon RDS uses Windows Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html\">Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server</a> in the <i>Amazon RDS User Guide</i>. </p>"
"documentation":"<p>The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.</p> <p>For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html\"> Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html\"> Using Kerberos Authentication with Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.</p> <p/>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
@ -3038,7 +3048,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>You can enable IAM database authentication for the following database engines:</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.</p> <p> <b>MySQL</b> </p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> </ul>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>You can enable IAM database authentication for the following database engines:</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.</p> <p> <b>MySQL</b> </p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> <li> <p>For MySQL 8.0, minor version 8.0.16 or higher</p> </li> </ul> <p> <b>PostgreSQL</b> </p> <ul> <li> <p>For PostgreSQL 9.5, minor version 9.5.15 or higher</p> </li> <li> <p>For PostgreSQL 9.6, minor version 9.6.11 or higher</p> </li> <li> <p>PostgreSQL 10.6, 10.7, and 10.9</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
@ -3114,6 +3124,10 @@
"shape":"String",
"documentation":"<p>The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.</p>"
},
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group to associate with this DB instance.</p> <p>If you do not specify a value for <code>DBParameterGroupName</code>, then Amazon RDS uses the <code>DBParameterGroup</code> of source DB instance for a same region Read Replica, or the default <code>DBParameterGroup</code> for the specified DB engine for a cross region Read Replica.</p> <p>Constraints:</p> <ul> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens</p> </li> </ul>"
},
"PubliclyAccessible":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see <a>CreateDBInstance</a>.</p>"
@ -3153,7 +3167,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>You can enable IAM database authentication for the following database engines</p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> <li> <p>Aurora MySQL 5.6 or higher</p> </li> </ul>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see <a>CreateDBInstance</a>.</p> <p>For more information about IAM database authentication, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
@ -3182,6 +3196,14 @@
"DeletionProtection":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html\"> Deleting a DB Instance</a>. </p>"
},
"Domain":{
"shape":"String",
"documentation":"<p>The Active Directory directory ID to create the DB instance in.</p> <p>For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html\"> Using Kerberos Authentication with Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DomainIAMRoleName":{
"shape":"String",
"documentation":"<p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>"
}
}
},
@ -3603,7 +3625,7 @@
},
"EngineMode":{
"shape":"String",
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, or <code>parallelquery</code>.</p>"
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>"
},
"ScalingConfigurationInfo":{"shape":"ScalingConfigurationInfo"},
"DeletionProtection":{
@ -3771,7 +3793,7 @@
},
"CustomEndpointType":{
"shape":"String",
"documentation":"<p>The type associated with a custom endpoint. One of: <code>READER</code>, <code>ANY</code>.</p>"
"documentation":"<p>The type associated with a custom endpoint. One of: <code>READER</code>, <code>WRITER</code>, <code>ANY</code>.</p>"
},
"StaticMembers":{
"shape":"StringList",
@ -3860,7 +3882,7 @@
},
"IsClusterWriter":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whehter the cluster member is the primary instance for the DB cluster.</p>"
"documentation":"<p>Value that is <code>true</code> if the cluster member is the primary instance for the DB cluster and <code>false</code> otherwise.</p>"
},
"DBClusterParameterGroupStatus":{
"shape":"String",
@ -4961,7 +4983,7 @@
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DP parameter group.</p>"
"documentation":"<p>The name of the DB parameter group.</p>"
},
"ParameterApplyStatus":{
"shape":"String",
@ -5826,7 +5848,7 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
"documentation":"<p>A filter that specifies one or more DB cluster snapshots to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).</p> </li> <li> <p> <code>db-cluster-snapshot-id</code> - Accepts DB cluster snapshot identifiers.</p> </li> <li> <p> <code>snapshot-type</code> - Accepts types of DB cluster snapshots.</p> </li> <li> <p> <code>engine</code> - Accepts names of database engines.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
@ -5953,7 +5975,7 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.</p> </li> </ul>"
"documentation":"<p>A filter that specifies one or more DB instances to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-cluster-id</code> - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.</p> </li> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.</p> </li> <li> <p> <code>dbi-resource-id</code> - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.</p> </li> <li> <p> <code>domain</code> - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.</p> </li> <li> <p> <code>engine</code> - Accepts engine names. The results list will only include information about the DB instances for these engines.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
@ -6144,7 +6166,7 @@
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
"documentation":"<p>A filter that specifies one or more DB snapshots to describe.</p> <p>Supported filters:</p> <ul> <li> <p> <code>db-instance-id</code> - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).</p> </li> <li> <p> <code>db-snapshot-id</code> - Accepts DB snapshot identifiers.</p> </li> <li> <p> <code>dbi-resource-id</code> - Accepts identifiers of source DB instances.</p> </li> <li> <p> <code>snapshot-type</code> - Accepts types of DB snapshots.</p> </li> <li> <p> <code>engine</code> - Accepts names of database engines.</p> </li> </ul>"
},
"MaxRecords":{
"shape":"IntegerOptional",
@ -6497,6 +6519,10 @@
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to show only those reservations that support Multi-AZ.</p>"
},
"LeaseId":{
"shape":"String",
"documentation":"<p>The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.</p> <note> <p>AWS Support might request the lease ID for an issue related to a reserved DB instance.</p> </note>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</p>"
@ -7517,7 +7543,7 @@
},
"EndpointType":{
"shape":"String",
"documentation":"<p>The type of the endpoint. One of: <code>READER</code>, <code>ANY</code>. </p>"
"documentation":"<p>The type of the endpoint. One of: <code>READER</code>, <code>WRITER</code>, <code>ANY</code>.</p>"
},
"StaticMembers":{
"shape":"StringList",
@ -7579,7 +7605,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
@ -7591,7 +7617,7 @@
},
"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 <code>ApplyImmediately</code> is enabled.</p> <p>For a list of valid engine versions, use <a>DescribeDBEngineVersions</a>.</p>"
"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 <code>ApplyImmediately</code> is enabled.</p> <p>To list all of the available engine versions for <code>aurora</code> (for MySQL 5.6-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-postgresql</code>, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p>"
},
"AllowMajorVersionUpgrade":{
"shape":"Boolean",
@ -7778,7 +7804,7 @@
},
"Domain":{
"shape":"String",
"documentation":"<p>The Active Directory Domain to move the instance to. Specify <code>none</code> to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain. </p>"
"documentation":"<p>The Active Directory directory ID to move the DB instance to. Specify <code>none</code> to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. </p> <p>For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html\"> Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html\"> Using Kerberos Authentication with Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
@ -7810,7 +7836,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>You can enable IAM database authentication for the following database engines</p> <p> <b>Amazon Aurora</b> </p> <p>Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see <code>ModifyDBCluster</code>.</p> <p> <b>MySQL</b> </p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> </ul>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see <a>CreateDBInstance</a>.</p> <p>For more information about IAM database authentication, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"EnablePerformanceInsights":{
"shape":"BooleanOptional",
@ -7862,7 +7888,7 @@
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> </ul>"
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing <code>DBParameterGroup</code>.</p> </li> </ul>"
},
"Parameters":{
"shape":"ParametersList",
@ -8567,6 +8593,10 @@
"SupportsStorageAutoscaling":{
"shape":"BooleanOptional",
"documentation":"<p>Whether or not Amazon RDS can automatically scale storage for DB instances that use the specified instance class.</p>"
},
"SupportsKerberosAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>Whether a DB instance supports Kerberos Authentication.</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 <code>DescribeOrderableDBInstanceOptions</code> action. </p>",
@ -8673,11 +8703,11 @@
},
"AutoAppliedAfterDate":{
"shape":"TStamp",
"documentation":"<p>The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any <code>next-maintenance</code> opt-in requests are ignored.</p>"
"documentation":"<p>The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.</p>"
},
"ForcedApplyDate":{
"shape":"TStamp",
"documentation":"<p>The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any <code>immediate</code> opt-in requests are ignored.</p>"
"documentation":"<p>The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource.</p>"
},
"OptInStatus":{
"shape":"String",
@ -8845,7 +8875,7 @@
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 0 to 8</p> </li> </ul>"
"documentation":"<p>The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.</p> <p>Default: 1</p> <p>Constraints:</p> <ul> <li> <p>Must be a value from 0 to 35.</p> </li> <li> <p>Can't be set to 0 if the DB instance is a source to Read Replicas.</p> </li> </ul>"
},
"PreferredBackupWindow":{
"shape":"String",
@ -9157,6 +9187,10 @@
"ReservedDBInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the reserved DB instance.</p>"
},
"LeaseId":{
"shape":"String",
"documentation":"<p>The unique identifier for the lease associated with the reserved DB instance.</p> <note> <p>AWS Support might request the lease ID for an issue related to a reserved DB instance.</p> </note>"
}
},
"documentation":"<p> This data type is used as a response element in the <code>DescribeReservedDBInstances</code> and <code>PurchaseReservedDBInstancesOffering</code> actions. </p>",
@ -9324,7 +9358,7 @@
"members":{
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing DBParameterGroup.</p> </li> </ul>"
"documentation":"<p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must match the name of an existing <code>DBParameterGroup</code>.</p> </li> </ul>"
},
"ResetAllParameters":{
"shape":"Boolean",
@ -9415,7 +9449,7 @@
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version number of the database engine to use.</p> <p> <b>Aurora MySQL</b> </p> <p>Example: <code>5.6.10a</code> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Example: <code>9.6.3</code> </p>"
"documentation":"<p>The version number of the database engine to use.</p> <p>To list all of the available engine versions for <code>aurora</code> (for MySQL 5.6-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-postgresql</code>, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p> <b>Aurora MySQL</b> </p> <p>Example: <code>5.6.10a</code>, <code>5.6.mysql_aurora.1.19.2</code>, <code>5.7.12</code>, <code>5.7.mysql_aurora.2.04.5</code> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Example: <code>9.6.3</code>, <code>10.7</code> </p>"
},
"Port":{
"shape":"IntegerOptional",
@ -9452,7 +9486,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p>"
},
"SourceEngine":{
"shape":"String",
@ -9524,7 +9558,7 @@
},
"EngineVersion":{
"shape":"String",
"documentation":"<p>The version of the database engine to use for the new DB cluster.</p>"
"documentation":"<p>The version of the database engine to use for the new DB cluster.</p> <p>To list all of the available engine versions for <code>aurora</code> (for MySQL 5.6-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-mysql</code> (for MySQL 5.7-compatible Aurora), use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p>To list all of the available engine versions for <code>aurora-postgresql</code>, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"</code> </p> <p> <b>Aurora MySQL</b> </p> <p>Example: <code>5.6.10a</code>, <code>5.6.mysql_aurora.1.19.2</code>, <code>5.7.12</code>, <code>5.7.mysql_aurora.2.04.5</code> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Example: <code>9.6.3</code>, <code>10.7</code> </p>"
},
"Port":{
"shape":"IntegerOptional",
@ -9556,7 +9590,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
@ -9568,7 +9602,7 @@
},
"EngineMode":{
"shape":"String",
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, or <code>parallelquery</code>.</p>"
"documentation":"<p>The DB engine mode of the DB cluster, either <code>provisioned</code>, <code>serverless</code>, <code>parallelquery</code>, <code>global</code>, or <code>multimaster</code>.</p>"
},
"ScalingConfiguration":{
"shape":"ScalingConfiguration",
@ -9645,7 +9679,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication</a> in the <i>Amazon Aurora User Guide.</i> </p>"
},
"BacktrackWindow":{
"shape":"LongOptional",
@ -9758,7 +9792,7 @@
},
"Domain":{
"shape":"String",
"documentation":"<p>Specify the Active Directory Domain to restore the instance in.</p>"
"documentation":"<p>Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. </p> <p>For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html\"> Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html\"> Using Kerberos Authentication with Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"CopyTagsToSnapshot":{
"shape":"BooleanOptional",
@ -9770,7 +9804,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>You can enable IAM database authentication for the following database engines</p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> </ul>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see <a>CreateDBInstance</a>.</p> <p>For more information about IAM database authentication, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
@ -9786,7 +9820,7 @@
},
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
"documentation":"<p>The name of the DB parameter group to associate with this DB instance.</p> <p>If you do not specify a value for <code>DBParameterGroupName</code>, then the default <code>DBParameterGroup</code> for the specified DB engine is used.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"DeletionProtection":{
"shape":"BooleanOptional",
@ -9863,7 +9897,7 @@
},
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used. </p>"
"documentation":"<p>The name of the DB parameter group to associate with this DB instance.</p> <p>If you do not specify a value for <code>DBParameterGroupName</code>, then the default <code>DBParameterGroup</code> for the specified DB engine is used.</p>"
},
"BackupRetentionPeriod":{
"shape":"IntegerOptional",
@ -9895,7 +9929,7 @@
},
"Iops":{
"shape":"IntegerOptional",
"documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide.</i> </p>"
"documentation":"<p>The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS\">Amazon RDS Provisioned IOPS Storage to Improve Performance</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"OptionGroupName":{
"shape":"String",
@ -9935,7 +9969,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see <a>CreateDBInstance</a>.</p> <p>For more information about IAM database authentication, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"SourceEngine":{
"shape":"String",
@ -10084,7 +10118,7 @@
},
"Domain":{
"shape":"String",
"documentation":"<p>Specify the Active Directory Domain to restore the instance in.</p>"
"documentation":"<p>Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain. </p> <p>For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html\"> Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html\"> Using Kerberos Authentication with Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>.</p>"
},
"DomainIAMRoleName":{
"shape":"String",
@ -10092,7 +10126,7 @@
},
"EnableIAMDatabaseAuthentication":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.</p> <p>You can enable IAM database authentication for the following database engines</p> <ul> <li> <p>For MySQL 5.6, minor version 5.6.34 or higher</p> </li> <li> <p>For MySQL 5.7, minor version 5.7.16 or higher</p> </li> </ul>"
"documentation":"<p>A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see <a>CreateDBInstance</a>.</p> <p>For more information about IAM database authentication, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html\"> IAM Database Authentication for MySQL and PostgreSQL</a> in the <i>Amazon RDS User Guide.</i> </p>"
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
@ -10108,7 +10142,7 @@
},
"DBParameterGroupName":{
"shape":"String",
"documentation":"<p>The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
"documentation":"<p>The name of the DB parameter group to associate with this DB instance.</p> <p>If you do not specify a value for <code>DBParameterGroupName</code>, then the default <code>DBParameterGroup</code> for the specified DB engine is used.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> <li> <p>Must be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
},
"DeletionProtection":{
"shape":"BooleanOptional",

97
botocore/data/rds/2014-10-31/waiters-2.json
View file

@ -50,10 +50,10 @@
"maxAttempts": 60,
"acceptors": [
{
"expected": "deleted",
"matcher": "pathAll",
"expected": true,
"matcher": "path",
"state": "success",
"argument": "DBInstances[].DBInstanceStatus"
"argument": "length(DBInstances) == `0`"
},
{
"expected": "DBInstanceNotFound",
@ -135,10 +135,10 @@
"maxAttempts": 60,
"acceptors": [
{
"expected": "deleted",
"matcher": "pathAll",
"expected": true,
"matcher": "path",
"state": "success",
"argument": "DBSnapshots[].Status"
"argument": "length(DBSnapshots) == `0`"
},
{
"expected": "DBSnapshotNotFound",
@ -171,6 +171,91 @@
}
]
},
"DBClusterSnapshotAvailable": {
"delay": 30,
"operation": "DescribeDBClusterSnapshots",
"maxAttempts": 60,
"acceptors": [
{
"expected": "available",
"matcher": "pathAll",
"state": "success",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "deleted",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "deleting",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "failed",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "incompatible-restore",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "incompatible-parameters",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
}
]
},
"DBClusterSnapshotDeleted": {
"delay": 30,
"operation": "DescribeDBClusterSnapshots",
"maxAttempts": 60,
"acceptors": [
{
"expected": true,
"matcher": "path",
"state": "success",
"argument": "length(DBClusterSnapshots) == `0`"
},
{
"expected": "DBClusterSnapshotNotFoundFault",
"matcher": "error",
"state": "success"
},
{
"expected": "creating",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "modifying",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "rebooting",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
},
{
"expected": "resetting-master-credentials",
"matcher": "pathAny",
"state": "failure",
"argument": "DBClusterSnapshots[].Status"
}
]
},
"DBSnapshotCompleted": {
"delay": 15,
"operation": "DescribeDBSnapshots",

6
botocore/data/redshift/2012-12-01/paginators-1.json
View file

@ -131,6 +131,12 @@
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "ReservedNodeOfferings"
},
"DescribeNodeConfigurationOptions": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "NodeConfigurationOptionList"
}
}
}

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

@ -807,6 +807,23 @@
],
"documentation":"<p>Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.</p>"
},
"DescribeNodeConfigurationOptions":{
"name":"DescribeNodeConfigurationOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeNodeConfigurationOptionsMessage"},
"output":{
"shape":"NodeConfigurationOptionsMessage",
"resultWrapper":"DescribeNodeConfigurationOptionsResult"
},
"errors":[
{"shape":"ClusterSnapshotNotFoundFault"},
{"shape":"InvalidClusterSnapshotStateFault"}
],
"documentation":"<p>Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.</p>"
},
"DescribeOrderableClusterOptions":{
"name":"DescribeOrderableClusterOptions",
"http":{
@ -1561,6 +1578,10 @@
"locationName":"AccountWithRestoreAccess"
}
},
"ActionType":{
"type":"string",
"enum":["restore-cluster"]
},
"AssociatedClusterList":{
"type":"list",
"member":{
@ -2009,6 +2030,10 @@
"shape":"String",
"documentation":"<p> The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:</p> <ul> <li> <p>OnTrack - The next snapshot is expected to be taken on time. </p> </li> <li> <p>Pending - The next snapshot is pending to be taken. </p> </li> </ul>"
},
"NextMaintenanceWindowStartTime":{
"shape":"TStamp",
"documentation":"<p>The date and time in UTC when system maintenance can begin.</p>"
},
"ResizeInfo":{
"shape":"ResizeInfo",
"documentation":"<p>Returns the following:</p> <ul> <li> <p>AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.</p> </li> <li> <p>ResizeType: Returns ClassicResize</p> </li> </ul>"
@ -3841,6 +3866,37 @@
},
"documentation":"<p/>"
},
"DescribeNodeConfigurationOptionsMessage":{
"type":"structure",
"required":["ActionType"],
"members":{
"ActionType":{
"shape":"ActionType",
"documentation":"<p>The action type to evaluate for possible node configurations. Currently, it must be \"restore-cluster\".</p>"
},
"SnapshotIdentifier":{
"shape":"String",
"documentation":"<p>The identifier of the snapshot to evaluate for possible node configurations.</p>"
},
"OwnerAccount":{
"shape":"String",
"documentation":"<p>The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.</p>"
},
"Filters":{
"shape":"NodeConfigurationOptionsFilterList",
"documentation":"<p>A set of name, operator, and value items to filter the results.</p>",
"locationName":"Filter"
},
"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 <a>DescribeNodeConfigurationOptions</a> request exceed the value specified in <code>MaxRecords</code>, AWS 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>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>500</code> </p> <p>Constraints: minimum 100, maximum 500.</p>"
}
}
},
"DescribeOrderableClusterOptionsMessage":{
"type":"structure",
"members":{
@ -5425,6 +5481,78 @@
}
}
},
"NodeConfigurationOption":{
"type":"structure",
"members":{
"NodeType":{
"shape":"String",
"documentation":"<p>The node type, such as, \"ds2.8xlarge\".</p>"
},
"NumberOfNodes":{
"shape":"Integer",
"documentation":"<p>The number of nodes.</p>"
},
"EstimatedDiskUtilizationPercent":{
"shape":"DoubleOptional",
"documentation":"<p>The estimated disk utilizaton percentage.</p>"
}
},
"documentation":"<p>A list of node configurations.</p>"
},
"NodeConfigurationOptionList":{
"type":"list",
"member":{
"shape":"NodeConfigurationOption",
"locationName":"NodeConfigurationOption"
}
},
"NodeConfigurationOptionsFilter":{
"type":"structure",
"members":{
"Name":{
"shape":"NodeConfigurationOptionsFilterName",
"documentation":"<p>The name of the element to filter.</p>"
},
"Operator":{
"shape":"OperatorType",
"documentation":"<p>The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.</p>"
},
"Values":{
"shape":"ValueStringList",
"documentation":"<p>List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).</p>",
"locationName":"Value"
}
},
"documentation":"<p>A set of elements to filter the returned node configurations.</p>"
},
"NodeConfigurationOptionsFilterList":{
"type":"list",
"member":{
"shape":"NodeConfigurationOptionsFilter",
"locationName":"NodeConfigurationOptionsFilter"
}
},
"NodeConfigurationOptionsFilterName":{
"type":"string",
"enum":[
"NodeType",
"NumberOfNodes",
"EstimatedDiskUtilizationPercent"
]
},
"NodeConfigurationOptionsMessage":{
"type":"structure",
"members":{
"NodeConfigurationOptionList":{
"shape":"NodeConfigurationOptionList",
"documentation":"<p>A list of valid node configurations.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the <code>Marker</code> parameter and retrying the command. If the <code>Marker</code> field is empty, all response records have been retrieved for the request. </p>"
}
}
},
"NumberOfNodesPerClusterLimitExceededFault":{
"type":"structure",
"members":{
@ -5449,6 +5577,18 @@
},
"exception":true
},
"OperatorType":{
"type":"string",
"enum":[
"eq",
"lt",
"gt",
"le",
"ge",
"in",
"between"
]
},
"OrderableClusterOption":{
"type":"structure",
"members":{
@ -6156,6 +6296,10 @@
"SnapshotScheduleIdentifier":{
"shape":"String",
"documentation":"<p>A unique identifier for the snapshot schedule.</p>"
},
"NumberOfNodes":{
"shape":"IntegerOptional",
"documentation":"<p>The number of nodes specified when provisioning the restored cluster.</p>"
}
},
"documentation":"<p/>"
@ -7306,6 +7450,13 @@
},
"documentation":"<p>A maintenance track that you can switch the current track to.</p>"
},
"ValueStringList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"item"
}
},
"VpcSecurityGroupIdList":{
"type":"list",
"member":{

56
botocore/data/rekognition/2016-06-27/service-2.json
View file

@ -218,7 +218,7 @@
{"shape":"ProvisionedThroughputExceededException"},
{"shape":"InvalidImageFormatException"}
],
"documentation":"<p>Detects explicit or suggestive adult content in a specified JPEG or PNG format image. Use <code>DetectModerationLabels</code> to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.</p> <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to determine which types of content are appropriate.</p> <p>For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p> <p>You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>"
"documentation":"<p>Detects unsafe content in a specified JPEG or PNG format image. Use <code>DetectModerationLabels</code> to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.</p> <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to determine which types of content are appropriate.</p> <p>For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p> <p>You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>"
},
"DetectText":{
"name":"DetectText",
@ -294,7 +294,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Gets the content moderation analysis results for a Amazon Rekognition Video analysis started by <a>StartContentModeration</a>.</p> <p>Content moderation analysis of a video is an asynchronous operation. You start analysis by calling <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartContentModeration</code>. To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p> <p>For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.</p> <p> <code>GetContentModeration</code> returns detected content moderation labels, and the time they are detected, in an array, <code>ModerationLabels</code>, of <a>ContentModerationDetection</a> objects. </p> <p>By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code> input parameter. </p> <p>Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code> and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code> returned from the previous call to <code>GetContentModeration</code>.</p> <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>"
"documentation":"<p>Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by <a>StartContentModeration</a>.</p> <p>Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartContentModeration</code>. To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p> <p>For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.</p> <p> <code>GetContentModeration</code> returns detected unsafe content labels, and the time they are detected, in an array, <code>ModerationLabels</code>, of <a>ContentModerationDetection</a> objects. </p> <p>By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code> input parameter. </p> <p>Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code> and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code> returned from the previous call to <code>GetContentModeration</code>.</p> <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>"
},
"GetFaceDetection":{
"name":"GetFaceDetection",
@ -550,7 +550,7 @@
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p> Starts asynchronous detection of explicit or suggestive adult content in a stored video.</p> <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartContentModeration</code> returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis. When content moderation analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p> <p>To get the results of the content moderation analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p> <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>",
"documentation":"<p> Starts asynchronous detection of unsafe content in a stored video.</p> <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartContentModeration</code> returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis. When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p> <p>To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p> <p>For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>",
"idempotent":true
},
"StartFaceDetection":{
@ -969,14 +969,14 @@
"members":{
"Timestamp":{
"shape":"Timestamp",
"documentation":"<p>Time, in milliseconds from the beginning of the video, that the moderation label was detected.</p>"
"documentation":"<p>Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.</p>"
},
"ModerationLabel":{
"shape":"ModerationLabel",
"documentation":"<p>The moderation label detected by in the stored video.</p>"
"documentation":"<p>The unsafe content label detected by in the stored video.</p>"
}
},
"documentation":"<p>Information about a moderation label detection in a stored video.</p>"
"documentation":"<p>Information about an unsafe content label detection in a stored video.</p>"
},
"ContentModerationDetections":{
"type":"list",
@ -1290,7 +1290,7 @@
"members":{
"ModerationLabels":{
"shape":"ModerationLabels",
"documentation":"<p>Array of detected Moderation labels and the time, in millseconds from the start of the video, they were detected.</p>"
"documentation":"<p>Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.</p>"
},
"ModerationModelVersion":{
"shape":"String",
@ -1329,7 +1329,7 @@
"documentation":"<p>Level of confidence in the determination.</p>"
}
},
"documentation":"<p>The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.</p>"
"documentation":"<p>The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.</p>"
},
"EmotionName":{
"type":"string",
@ -1461,7 +1461,7 @@
},
"Emotions":{
"shape":"Emotions",
"documentation":"<p>The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY. </p>"
"documentation":"<p>The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.</p>"
},
"Landmarks":{
"shape":"Landmarks",
@ -1691,7 +1691,7 @@
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier for the content moderation job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetContentModeration</code>.</p>"
"documentation":"<p>The identifier for the unsafe content job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetContentModeration</code>.</p>"
},
"MaxResults":{
"shape":"MaxResults",
@ -1699,7 +1699,7 @@
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.</p>"
"documentation":"<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of unsafe content labels.</p>"
},
"SortBy":{
"shape":"ContentModerationSortBy",
@ -1712,7 +1712,7 @@
"members":{
"JobStatus":{
"shape":"VideoJobStatus",
"documentation":"<p>The current status of the content moderation job.</p>"
"documentation":"<p>The current status of the unsafe content analysis job.</p>"
},
"StatusMessage":{
"shape":"StatusMessage",
@ -1724,11 +1724,11 @@
},
"ModerationLabels":{
"shape":"ContentModerationDetections",
"documentation":"<p>The detected moderation labels and the time(s) they were detected.</p>"
"documentation":"<p>The detected unsafe content labels and the time(s) they were detected.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of moderation labels. </p>"
"documentation":"<p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of unsafe content labels. </p>"
},
"ModerationModelVersion":{
"shape":"String",
@ -2351,14 +2351,14 @@
},
"Name":{
"shape":"String",
"documentation":"<p>The label name for the type of content detected in the image.</p>"
"documentation":"<p>The label name for the type of unsafe content detected in the image.</p>"
},
"ParentName":{
"shape":"String",
"documentation":"<p>The name for the parent label. Labels at the top level of the hierarchy have the parent label <code>\"\"</code>.</p>"
}
},
"documentation":"<p>Provides information about a single type of moderated content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>"
"documentation":"<p>Provides information about a single type of unsafe content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.</p>"
},
"ModerationLabels":{
"type":"list",
@ -2693,7 +2693,7 @@
},
"FaceMatchThreshold":{
"shape":"Percent",
"documentation":"<p>(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.</p>"
"documentation":"<p>(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>"
}
}
},
@ -2739,7 +2739,7 @@
},
"FaceMatchThreshold":{
"shape":"Percent",
"documentation":"<p>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.</p>"
"documentation":"<p>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%. </p>"
}
}
},
@ -2792,7 +2792,7 @@
},
"JobTag":{
"shape":"JobTag",
"documentation":"<p>Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. </p>"
"documentation":"<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
}
}
},
@ -2811,7 +2811,7 @@
"members":{
"Video":{
"shape":"Video",
"documentation":"<p>The video in which you want to moderate content. The video must be stored in an Amazon S3 bucket.</p>"
"documentation":"<p>The video in which you want to detect unsafe content. The video must be stored in an Amazon S3 bucket.</p>"
},
"MinConfidence":{
"shape":"Percent",
@ -2823,11 +2823,11 @@
},
"NotificationChannel":{
"shape":"NotificationChannel",
"documentation":"<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the content moderation analysis to.</p>"
"documentation":"<p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the unsafe content analysis to.</p>"
},
"JobTag":{
"shape":"JobTag",
"documentation":"<p>Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. </p>"
"documentation":"<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
}
}
},
@ -2836,7 +2836,7 @@
"members":{
"JobId":{
"shape":"JobId",
"documentation":"<p>The identifier for the content moderation analysis job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetContentModeration</code>.</p>"
"documentation":"<p>The identifier for the unsafe content analysis job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetContentModeration</code>.</p>"
}
}
},
@ -2862,7 +2862,7 @@
},
"JobTag":{
"shape":"JobTag",
"documentation":"<p>Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. </p>"
"documentation":"<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
}
}
},
@ -2892,7 +2892,7 @@
},
"FaceMatchThreshold":{
"shape":"Percent",
"documentation":"<p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. </p>"
"documentation":"<p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</p>"
},
"CollectionId":{
"shape":"CollectionId",
@ -2904,7 +2904,7 @@
},
"JobTag":{
"shape":"JobTag",
"documentation":"<p>Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. </p>"
"documentation":"<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
}
}
},
@ -2939,7 +2939,7 @@
},
"JobTag":{
"shape":"JobTag",
"documentation":"<p>Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. </p>"
"documentation":"<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
}
}
},
@ -2970,7 +2970,7 @@
},
"JobTag":{
"shape":"JobTag",
"documentation":"<p>Unique identifier you specify to identify the job in the completion status published to the Amazon Simple Notification Service topic. </p>"
"documentation":"<p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"
}
}
},

2
botocore/data/resourcegroupstaggingapi/2017-01-26/service-2.json
View file

File diff suppressed because one or more lines are too long

237
botocore/data/robomaker/2018-06-29/service-2.json
View file

@ -648,6 +648,7 @@
}
},
"Boolean":{"type":"boolean"},
"BoxedBoolean":{"type":"boolean"},
"CancelDeploymentJobRequest":{
"type":"structure",
"required":["job"],
@ -977,8 +978,7 @@
"name",
"sources",
"simulationSoftwareSuite",
"robotSoftwareSuite",
"renderingEngine"
"robotSoftwareSuite"
],
"members":{
"name":{
@ -1123,6 +1123,10 @@
"shape":"OutputLocation",
"documentation":"<p>Location for output files generated by the simulation job.</p>"
},
"loggingConfig":{
"shape":"LoggingConfig",
"documentation":"<p>The logging configuration.</p>"
},
"maxJobDurationInSeconds":{
"shape":"JobDuration",
"documentation":"<p>The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When <code>maxJobDurationInSeconds</code> is reached, the simulation job will status will transition to <code>Completed</code>.</p>"
@ -1143,6 +1147,10 @@
"shape":"SimulationApplicationConfigs",
"documentation":"<p>The simulation application to use in the simulation job.</p>"
},
"dataSources":{
"shape":"DataSourceConfigs",
"documentation":"<p>The data sources for the simulation job.</p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the simulation job.</p>"
@ -1188,6 +1196,10 @@
"shape":"OutputLocation",
"documentation":"<p>Simulation job output files location.</p>"
},
"loggingConfig":{
"shape":"LoggingConfig",
"documentation":"<p>The logging configuration.</p>"
},
"maxJobDurationInSeconds":{
"shape":"JobDuration",
"documentation":"<p>The maximum simulation job duration in seconds. </p>"
@ -1208,6 +1220,10 @@
"shape":"SimulationApplicationConfigs",
"documentation":"<p>The simulation application used by the simulation job.</p>"
},
"dataSources":{
"shape":"DataSources",
"documentation":"<p>The data sources for the simulation job.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The list of all tags added to the simulation job.</p>"
@ -1219,6 +1235,61 @@
}
},
"CreatedAt":{"type":"timestamp"},
"DataSource":{
"type":"structure",
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the data source.</p>"
},
"s3Bucket":{
"shape":"S3Bucket",
"documentation":"<p>The S3 bucket where the data files are located.</p>"
},
"s3Keys":{
"shape":"S3KeyOutputs",
"documentation":"<p>The list of S3 keys identifying the data source files.</p>"
}
},
"documentation":"<p>Information about a data source.</p>"
},
"DataSourceConfig":{
"type":"structure",
"required":[
"name",
"s3Bucket",
"s3Keys"
],
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the data source.</p>"
},
"s3Bucket":{
"shape":"S3Bucket",
"documentation":"<p>The S3 bucket where the data files are located.</p>"
},
"s3Keys":{
"shape":"S3Keys",
"documentation":"<p>The list of S3 keys identifying the data source files.</p>"
}
},
"documentation":"<p>Information about a data source.</p>"
},
"DataSourceConfigs":{
"type":"list",
"member":{"shape":"DataSourceConfig"},
"max":5,
"min":1
},
"DataSourceNames":{
"type":"list",
"member":{"shape":"Name"}
},
"DataSources":{
"type":"list",
"member":{"shape":"DataSource"}
},
"DeleteFleetRequest":{
"type":"structure",
"required":["fleet"],
@ -1326,6 +1397,10 @@
"failureThresholdPercentage":{
"shape":"Percentage",
"documentation":"<p>The percentage of deployments that need to fail before stopping deployment.</p>"
},
"robotDeploymentTimeoutInSeconds":{
"shape":"DeploymentTimeout",
"documentation":"<p>The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.</p>"
}
},
"documentation":"<p>Information about a deployment configuration.</p>"
@ -1437,6 +1512,7 @@
"Canceled"
]
},
"DeploymentTimeout":{"type":"long"},
"DeploymentVersion":{
"type":"string",
"max":255,
@ -1793,6 +1869,10 @@
"shape":"OutputLocation",
"documentation":"<p>Location for output files generated by the simulation job.</p>"
},
"loggingConfig":{
"shape":"LoggingConfig",
"documentation":"<p>The logging configuration.</p>"
},
"maxJobDurationInSeconds":{
"shape":"JobDuration",
"documentation":"<p>The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.</p>"
@ -1813,6 +1893,10 @@
"shape":"SimulationApplicationConfigs",
"documentation":"<p>A list of simulation applications.</p>"
},
"dataSources":{
"shape":"DataSources",
"documentation":"<p>The data sources for the simulation job.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The list of all tags added to the specified simulation job.</p>"
@ -1820,6 +1904,10 @@
"vpcConfig":{
"shape":"VPCConfigResponse",
"documentation":"<p>The VPC configuration.</p>"
},
"networkInterface":{
"shape":"NetworkInterface",
"documentation":"<p>The network interface information for the simulation job.</p>"
}
}
},
@ -1971,6 +2059,10 @@
"environmentVariables":{
"shape":"EnvironmentVariableMap",
"documentation":"<p>The environment variables for the application launch.</p>"
},
"portForwardingConfig":{
"shape":"PortForwardingConfig",
"documentation":"<p>The port forwarding configuration.</p>"
}
},
"documentation":"<p>Information about a launch configuration.</p>"
@ -2194,6 +2286,17 @@
}
}
},
"LoggingConfig":{
"type":"structure",
"required":["recordAllRosTopics"],
"members":{
"recordAllRosTopics":{
"shape":"BoxedBoolean",
"documentation":"<p>A boolean indicating whether to record all ROS topics.</p>"
}
},
"documentation":"<p>The logging configuration.</p>"
},
"MaxResults":{"type":"integer"},
"Name":{
"type":"string",
@ -2201,10 +2304,33 @@
"min":1,
"pattern":"[a-zA-Z0-9_\\-]*"
},
"NetworkInterface":{
"type":"structure",
"members":{
"networkInterfaceId":{
"shape":"GenericString",
"documentation":"<p>The ID of the network interface.</p>"
},
"privateIpAddress":{
"shape":"GenericString",
"documentation":"<p>The IPv4 address of the network interface within the subnet.</p>"
},
"publicIpAddress":{
"shape":"GenericString",
"documentation":"<p>The IPv4 public address of the network interface.</p>"
}
},
"documentation":"<p>Describes a network interface.</p>"
},
"NonEmptyString":{
"type":"string",
"min":1
},
"NonSystemPort":{
"type":"integer",
"max":65535,
"min":1024
},
"OutputLocation":{
"type":"structure",
"members":{
@ -2240,6 +2366,49 @@
"max":100,
"min":1
},
"Port":{
"type":"integer",
"max":65535,
"min":1
},
"PortForwardingConfig":{
"type":"structure",
"members":{
"portMappings":{
"shape":"PortMappingList",
"documentation":"<p>The port mappings for the configuration.</p>"
}
},
"documentation":"<p>Configuration information for port forwarding.</p>"
},
"PortMapping":{
"type":"structure",
"required":[
"jobPort",
"applicationPort"
],
"members":{
"jobPort":{
"shape":"Port",
"documentation":"<p>The port number on the simulation job instance to use as a remote connection point. </p>"
},
"applicationPort":{
"shape":"NonSystemPort",
"documentation":"<p>The port number on the application.</p>"
},
"enableOnPublicIp":{
"shape":"Boolean",
"documentation":"<p>A Boolean indicating whether to enable this port mapping on public IP.</p>"
}
},
"documentation":"<p>An object representing a port mapping.</p>"
},
"PortMappingList":{
"type":"list",
"member":{"shape":"PortMapping"},
"max":10,
"min":0
},
"ProgressDetail":{
"type":"structure",
"members":{
@ -2425,9 +2594,7 @@
},
"RobotApplicationNames":{
"type":"list",
"member":{"shape":"Name"},
"max":1,
"min":1
"member":{"shape":"Name"}
},
"RobotApplicationSummaries":{
"type":"list",
@ -2566,6 +2733,30 @@
"min":1,
"pattern":".*"
},
"S3KeyOutput":{
"type":"structure",
"members":{
"s3Key":{
"shape":"S3Key",
"documentation":"<p>The S3 key.</p>"
},
"etag":{
"shape":"S3Etag",
"documentation":"<p>The etag for the object.</p>"
}
},
"documentation":"<p>Information about S3 keys.</p>"
},
"S3KeyOutputs":{
"type":"list",
"member":{"shape":"S3KeyOutput"}
},
"S3Keys":{
"type":"list",
"member":{"shape":"S3Key"},
"max":100,
"min":1
},
"SecurityGroups":{
"type":"list",
"member":{"shape":"NonEmptyString"},
@ -2611,9 +2802,7 @@
},
"SimulationApplicationNames":{
"type":"list",
"member":{"shape":"Name"},
"max":1,
"min":1
"member":{"shape":"Name"}
},
"SimulationApplicationSummaries":{
"type":"list",
@ -2694,6 +2883,10 @@
"shape":"OutputLocation",
"documentation":"<p>Location for output files generated by the simulation job.</p>"
},
"loggingConfig":{
"shape":"LoggingConfig",
"documentation":"<p>The logging configuration.</p>"
},
"maxJobDurationInSeconds":{
"shape":"JobDuration",
"documentation":"<p>The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.</p>"
@ -2714,6 +2907,10 @@
"shape":"SimulationApplicationConfigs",
"documentation":"<p>A list of simulation applications.</p>"
},
"dataSources":{
"shape":"DataSources",
"documentation":"<p>The data sources for the simulation job.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>A map that contains tag keys and tag values that are attached to the simulation job.</p>"
@ -2721,6 +2918,10 @@
"vpcConfig":{
"shape":"VPCConfigResponse",
"documentation":"<p>VPC configuration information.</p>"
},
"networkInterface":{
"shape":"NetworkInterface",
"documentation":"<p/>"
}
},
"documentation":"<p>Information about a simulation job.</p>"
@ -2733,6 +2934,7 @@
"SimulationApplicationCrash",
"BadPermissionsRobotApplication",
"BadPermissionsSimulationApplication",
"BadPermissionsS3Object",
"BadPermissionsS3Output",
"BadPermissionsCloudwatchLogs",
"SubnetIpLimitExceeded",
@ -2740,8 +2942,13 @@
"BadPermissionsUserCredentials",
"InvalidBundleRobotApplication",
"InvalidBundleSimulationApplication",
"InvalidS3Resource",
"MismatchedEtag",
"RobotApplicationVersionMismatchedEtag",
"SimulationApplicationVersionMismatchedEtag",
"ResourceNotFound",
"InvalidInput",
"WrongRegionS3Bucket",
"WrongRegionS3Output",
"WrongRegionRobotApplication",
"WrongRegionSimulationApplication"
@ -2794,6 +3001,10 @@
"robotApplicationNames":{
"shape":"RobotApplicationNames",
"documentation":"<p>A list of simulation job robot application names.</p>"
},
"dataSourceNames":{
"shape":"DataSourceNames",
"documentation":"<p>The names of the data sources.</p>"
}
},
"documentation":"<p>Summary information for a simulation job.</p>"
@ -2818,11 +3029,14 @@
},
"SimulationSoftwareSuiteType":{
"type":"string",
"enum":["Gazebo"]
"enum":[
"Gazebo",
"RosbagPlay"
]
},
"SimulationSoftwareSuiteVersionType":{
"type":"string",
"pattern":"7|9"
"pattern":"7|9|Kinetic|Melodic"
},
"SimulationTimeMillis":{"type":"long"},
"Source":{
@ -3081,8 +3295,7 @@
"application",
"sources",
"simulationSoftwareSuite",
"robotSoftwareSuite",
"renderingEngine"
"robotSoftwareSuite"
],
"members":{
"application":{

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

File diff suppressed because one or more lines are too long

10
botocore/data/securityhub/2018-10-26/service-2.json
View file

@ -641,6 +641,10 @@
"shapes":{
"AcceptInvitationRequest":{
"type":"structure",
"required":[
"MasterId",
"InvitationId"
],
"members":{
"MasterId":{
"shape":"NonEmptyString",
@ -1523,6 +1527,7 @@
},
"DeclineInvitationsRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
@ -1585,6 +1590,7 @@
},
"DeleteInvitationsRequest":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{
"shape":"AccountIdList",
@ -1655,7 +1661,9 @@
"members":{
"HubArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the Hub resource to retrieve.</p>"
"documentation":"<p>The ARN of the Hub resource to retrieve.</p>",
"location":"querystring",
"locationName":"HubArn"
}
}
},

14
botocore/data/ses/2010-12-01/service-2.json
View file

File diff suppressed because one or more lines are too long

77
botocore/data/sqs/2012-11-05/service-2.json
View file

File diff suppressed because one or more lines are too long

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

@ -1725,7 +1725,7 @@
{"shape":"InvalidAssociationVersion"},
{"shape":"AssociationVersionLimitExceeded"}
],
"documentation":"<p>Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.</p> <important> <p>When you update an association, the association immediately runs against the specified targets.</p> </important>"
"documentation":"<p>Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output. </p> <p>In order to call this API action, your IAM user account, group, or role must be configured with permission to call the <a>DescribeAssociation</a> API action. If you don't have permission to call DescribeAssociation, then you receive the following error: <code>An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: &lt;user_arn&gt; is not authorized to perform: ssm:DescribeAssociation on resource: &lt;resource_arn&gt;</code> </p> <important> <p>When you update an association, the association immediately runs against the specified targets.</p> </important>"
},
"UpdateAssociationStatus":{
"name":"UpdateAssociationStatus",
@ -3855,7 +3855,7 @@
},
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>The instance ID.</p>"
"documentation":"<p>The instance ID.</p> <note> <p> <code>InstanceId</code> has been deprecated. To specify an instance ID for an association, use the <code>Targets</code> parameter. If you use the parameter <code>InstanceId</code>, you cannot use the parameters <code>AssociationName</code>, <code>DocumentVersion</code>, <code>MaxErrors</code>, <code>MaxConcurrency</code>, <code>OutputLocation</code>, or <code>ScheduleExpression</code>. To use these parameters, you must use the <code>Targets</code> parameter.</p> </note>"
},
"Parameters":{
"shape":"Parameters",
@ -3863,7 +3863,7 @@
},
"Targets":{
"shape":"Targets",
"documentation":"<p>The targets (either instances or tags) for the association.</p>"
"documentation":"<p>The targets (either instances or tags) for the association. You must specify a value for <code>Targets</code> if you don't specify a value for <code>InstanceId</code>.</p>"
},
"ScheduleExpression":{
"shape":"ScheduleExpression",
@ -5012,7 +5012,7 @@
},
"Filters":{
"shape":"PatchOrchestratorFilterList",
"documentation":"<p>Each entry in the array is a structure containing:</p> <p>Key (string, between 1 and 128 characters)</p> <p>Values (array of strings, each string between 1 and 256 characters)</p>"
"documentation":"<p>An array of structures. Each entry in the array is a structure containing a Key, Value combination. Valid values for Key are <code>Classification</code> | <code>KBId</code> | <code>Severity</code> | <code>State</code>.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -7386,7 +7386,7 @@
},
"IsLatestVersion":{
"shape":"Boolean",
"documentation":"<p>Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.</p>",
"documentation":"<p>Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.</p>",
"box":true
},
"PlatformType":{
@ -8509,7 +8509,7 @@
},
"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>",
"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":{
@ -8524,6 +8524,10 @@
"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>"
},
"ParameterVersion":{
"shape":"PSParameterVersion",
"documentation":"<p>The version of the parameter that has been labeled.</p>"
}
}
},
@ -10569,7 +10573,8 @@
"type":"string",
"enum":[
"Standard",
"Advanced"
"Advanced",
"Intelligent-Tiering"
]
},
"ParameterType":{
@ -11082,7 +11087,7 @@
},
"PatchSourceConfiguration":{
"type":"string",
"max":512,
"max":1024,
"min":1,
"sensitive":true
},
@ -11293,7 +11298,7 @@
},
"Tier":{
"shape":"ParameterTier",
"documentation":"<p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a value limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters per account and per Region. Standard parameters are offered at no additional cost.</p> <p>Advanced parameters have a value limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters per account and per Region. Advanced parameters incur a charge.</p> <p>If you don't specify a parameter tier when you create a new parameter, the parameter defaults to using the standard tier. You can change a standard parameter to an advanced parameter at any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.</p> <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html\">About Advanced Parameters</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
"documentation":"<p>The parameter tier to assign to a parameter.</p> <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost. </p> <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html\">About Advanced Parameters</a> in the <i>AWS Systems Manager User Guide</i>.</p> <p>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters. </p> <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter. </p> <p> <b>Using the Default Tier Configuration</b> </p> <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</p> <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</p> <ul> <li> <p> <b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters. </p> </li> <li> <p> <b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced. </p> <p>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</p> <p>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary. </p> </li> </ul> <p>Options that require an advanced parameter include the following:</p> <ul> <li> <p>The content size of the parameter is more than 4 KB.</p> </li> <li> <p>The parameter uses a parameter policy.</p> </li> <li> <p>More than 10,000 parameters already exist in your AWS account in the current Region.</p> </li> </ul> <p>For more information about configuring the default tier option, see <a href=\"http://docs.aws.amazon.com/systems-manager/latest/userguide/ps-default-tier.html\">Specifying a Default Parameter Tier</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
},
"Policies":{
"shape":"ParameterPolicies",
@ -11307,6 +11312,10 @@
"Version":{
"shape":"PSParameterVersion",
"documentation":"<p>The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.</p>"
},
"Tier":{
"shape":"ParameterTier",
"documentation":"<p>The tier assigned to the parameter.</p>"
}
}
},
@ -13030,7 +13039,7 @@
},
"DocumentVersion":{
"shape":"DocumentVersion",
"documentation":"<p>The version of the document that you want to update.</p>"
"documentation":"<p>(Required) The version of the document that you want to update. </p>"
},
"DocumentFormat":{
"shape":"DocumentFormat",

155
botocore/data/stepfunctions/2016-11-23/service-2.json
View file

@ -26,7 +26,7 @@
{"shape":"InvalidName"},
{"shape":"TooManyTags"}
],
"documentation":"<p>Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>",
"documentation":"<p>Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateActivity</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateActivity</code>'s idempotency check is based on the activity <code>name</code>. If a following request has different <code>tags</code> values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>tags</code> will not be updated, even if they are different.</p> </note>",
"idempotent":true
},
"CreateStateMachine":{
@ -46,7 +46,7 @@
{"shape":"StateMachineLimitExceeded"},
{"shape":"TooManyTags"}
],
"documentation":"<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>",
"documentation":"<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency check is based on the state machine <code>name</code> and <code>definition</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>",
"idempotent":true
},
"DeleteActivity":{
@ -214,7 +214,7 @@
{"shape":"InvalidArn"},
{"shape":"ResourceNotFound"}
],
"documentation":"<p>List tags for a given resource.</p>"
"documentation":"<p>List tags for a given resource.</p> <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>"
},
"SendTaskFailure":{
"name":"SendTaskFailure",
@ -229,7 +229,7 @@
{"shape":"InvalidToken"},
{"shape":"TaskTimedOut"}
],
"documentation":"<p>Used by workers to report that the task identified by the <code>taskToken</code> failed.</p>"
"documentation":"<p>Used by activity workers and task states using the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token\">callback</a> pattern to report that the task identified by the <code>taskToken</code> failed.</p>"
},
"SendTaskHeartbeat":{
"name":"SendTaskHeartbeat",
@ -244,7 +244,7 @@
{"shape":"InvalidToken"},
{"shape":"TaskTimedOut"}
],
"documentation":"<p>Used by workers to report to the service that the task represented by the specified <code>taskToken</code> is still making progress. This action resets the <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an <code>ActivityTimedOut</code> event.</p> <note> <p>The <code>Timeout</code> of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of <a>SendTaskHeartbeat</a> requests received.</p> </note> <note> <p>This operation is only useful for long-lived tasks to report the liveliness of the task.</p> </note>"
"documentation":"<p>Used by activity workers and task states using the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token\">callback</a> pattern to report to Step Functions that the task represented by the specified <code>taskToken</code> is still making progress. This action resets the <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state machine's Amazon States Language definition (<code>HeartbeatSeconds</code>). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an <code>ActivityTimedOut</code> entry for activities, or a <code>TaskTimedOut</code> entry for for tasks using the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync\">job run</a> or <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token\">callback</a> pattern.</p> <note> <p>The <code>Timeout</code> of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of <a>SendTaskHeartbeat</a> requests received. Use <code>HeartbeatSeconds</code> to configure the timeout interval for heartbeats.</p> </note>"
},
"SendTaskSuccess":{
"name":"SendTaskSuccess",
@ -260,7 +260,7 @@
{"shape":"InvalidToken"},
{"shape":"TaskTimedOut"}
],
"documentation":"<p>Used by workers to report that the task identified by the <code>taskToken</code> completed successfully.</p>"
"documentation":"<p>Used by activity workers and task states using the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token\">callback</a> pattern to report that the task identified by the <code>taskToken</code> completed successfully.</p>"
},
"StartExecution":{
"name":"StartExecution",
@ -309,7 +309,7 @@
{"shape":"ResourceNotFound"},
{"shape":"TooManyTags"}
],
"documentation":"<p>Add a tag to a Step Functions resource.</p>"
"documentation":"<p>Add a tag to a Step Functions resource.</p> <p>An array of key-value pairs. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>, and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html\">Controlling Access Using IAM Tags</a>.</p> <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -393,7 +393,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"creationDate":{
"shape":"Timestamp",
@ -500,11 +500,11 @@
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The list of tags to add to a resource.</p>"
"documentation":"<p>The list of tags to add to a resource.</p> <p>An array of key-value pairs. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>, and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html\">Controlling Access Using IAM Tags</a>.</p> <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>"
}
}
},
@ -535,7 +535,7 @@
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the state machine. </p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the state machine. </p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"definition":{
"shape":"Definition",
@ -547,7 +547,7 @@
},
"tags":{
"shape":"TagList",
"documentation":"<p>Tags to be added when creating a state machine.</p>"
"documentation":"<p>Tags to be added when creating a state machine.</p> <p>An array of key-value pairs. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>, and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html\">Controlling Access Using IAM Tags</a>.</p> <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>"
}
}
},
@ -628,7 +628,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the activity.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"creationDate":{
"shape":"Timestamp",
@ -666,7 +666,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"status":{
"shape":"ExecutionStatus",
@ -758,7 +758,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"status":{
"shape":"StateMachineStatus",
@ -856,7 +856,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the execution.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"status":{
"shape":"ExecutionStatus",
@ -1054,6 +1054,26 @@
"executionSucceededEventDetails":{"shape":"ExecutionSucceededEventDetails"},
"executionAbortedEventDetails":{"shape":"ExecutionAbortedEventDetails"},
"executionTimedOutEventDetails":{"shape":"ExecutionTimedOutEventDetails"},
"mapStateStartedEventDetails":{
"shape":"MapStateStartedEventDetails",
"documentation":"<p>Contains details about Map state that was started.</p>"
},
"mapIterationStartedEventDetails":{
"shape":"MapIterationEventDetails",
"documentation":"<p>Contains details about an iteration of a Map state that was started.</p>"
},
"mapIterationSucceededEventDetails":{
"shape":"MapIterationEventDetails",
"documentation":"<p>Contains details about an iteration of a Map state that succeeded.</p>"
},
"mapIterationFailedEventDetails":{
"shape":"MapIterationEventDetails",
"documentation":"<p>Contains details about an iteration of a Map state that failed.</p>"
},
"mapIterationAbortedEventDetails":{
"shape":"MapIterationEventDetails",
"documentation":"<p>Contains details about an iteration of a Map state that was aborted.</p>"
},
"lambdaFunctionFailedEventDetails":{"shape":"LambdaFunctionFailedEventDetails"},
"lambdaFunctionScheduleFailedEventDetails":{"shape":"LambdaFunctionScheduleFailedEventDetails"},
"lambdaFunctionScheduledEventDetails":{"shape":"LambdaFunctionScheduledEventDetails"},
@ -1080,47 +1100,57 @@
"type":"string",
"enum":[
"ActivityFailed",
"ActivityScheduleFailed",
"ActivityScheduled",
"ActivityScheduleFailed",
"ActivityStarted",
"ActivitySucceeded",
"ActivityTimedOut",
"ChoiceStateEntered",
"ChoiceStateExited",
"TaskFailed",
"TaskScheduled",
"TaskStartFailed",
"TaskStarted",
"TaskSubmitFailed",
"TaskSubmitted",
"TaskSucceeded",
"TaskTimedOut",
"ExecutionAborted",
"ExecutionFailed",
"ExecutionStarted",
"ExecutionSucceeded",
"ExecutionAborted",
"ExecutionTimedOut",
"FailStateEntered",
"LambdaFunctionFailed",
"LambdaFunctionScheduleFailed",
"LambdaFunctionScheduled",
"LambdaFunctionStartFailed",
"LambdaFunctionScheduleFailed",
"LambdaFunctionStarted",
"LambdaFunctionStartFailed",
"LambdaFunctionSucceeded",
"LambdaFunctionTimedOut",
"SucceedStateEntered",
"SucceedStateExited",
"TaskStateAborted",
"TaskStateEntered",
"TaskStateExited",
"PassStateEntered",
"PassStateExited",
"MapIterationAborted",
"MapIterationFailed",
"MapIterationStarted",
"MapIterationSucceeded",
"MapStateAborted",
"MapStateEntered",
"MapStateExited",
"MapStateFailed",
"MapStateStarted",
"MapStateSucceeded",
"ParallelStateAborted",
"ParallelStateEntered",
"ParallelStateExited",
"ParallelStateFailed",
"ParallelStateStarted",
"ParallelStateSucceeded",
"PassStateEntered",
"PassStateExited",
"SucceedStateEntered",
"SucceedStateExited",
"TaskFailed",
"TaskScheduled",
"TaskStarted",
"TaskStartFailed",
"TaskStateAborted",
"TaskStateEntered",
"TaskStateExited",
"TaskSubmitFailed",
"TaskSubmitted",
"TaskSucceeded",
"TaskTimedOut",
"WaitStateAborted",
"WaitStateEntered",
"WaitStateExited"
@ -1308,7 +1338,7 @@
"documentation":"<p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.</p> <p>This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.</p>"
},
"nextToken":{
"shape":"PageToken",
"shape":"ListExecutionsPageToken",
"documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>"
}
}
@ -1322,11 +1352,16 @@
"documentation":"<p>The list of matching executions.</p>"
},
"nextToken":{
"shape":"PageToken",
"shape":"ListExecutionsPageToken",
"documentation":"<p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an <i>HTTP 400 InvalidToken</i> error.</p>"
}
}
},
"ListExecutionsPageToken":{
"type":"string",
"max":3096,
"min":1
},
"ListStateMachinesInput":{
"type":"structure",
"members":{
@ -1370,6 +1405,30 @@
}
}
},
"MapIterationEventDetails":{
"type":"structure",
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the iteration’s parent Map state.</p>"
},
"index":{
"shape":"UnsignedInteger",
"documentation":"<p>The index of the array belonging to the Map state iteration.</p>"
}
},
"documentation":"<p>Contains details about an iteration of a Map state.</p>"
},
"MapStateStartedEventDetails":{
"type":"structure",
"members":{
"length":{
"shape":"UnsignedInteger",
"documentation":"<p>The size of the array for Map state iterations.</p>"
}
},
"documentation":"<p>Details about a Map state that was started.</p>"
},
"MissingRequiredParameter":{
"type":"structure",
"members":{
@ -1399,7 +1458,7 @@
"message":{"shape":"ErrorMessage"},
"resourceName":{"shape":"Arn"}
},
"documentation":"<p>Could not fine the referenced resource. Only state machine and activity ARNs are supported.</p>",
"documentation":"<p>Could not find the referenced resource. Only state machine and activity ARNs are supported.</p>",
"exception":true
},
"ReverseOrder":{"type":"boolean"},
@ -1409,7 +1468,7 @@
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"<p>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).</p>"
"documentation":"<p>The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html\">context object</a> when a workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>"
},
"error":{
"shape":"SensitiveError",
@ -1432,7 +1491,7 @@
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"<p>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see <a>GetActivityTaskOutput$taskToken</a>).</p>"
"documentation":"<p>The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html\">context object</a> when a workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>"
}
}
},
@ -1450,7 +1509,7 @@
"members":{
"taskToken":{
"shape":"TaskToken",
"documentation":"<p>The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see <a>GetActivityTaskOutput$taskToken</a>).</p>"
"documentation":"<p>The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html\">context object</a> when a workflow enters a task state. See <a>GetActivityTaskOutput$taskToken</a>.</p>"
},
"output":{
"shape":"SensitiveData",
@ -1495,7 +1554,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions\"> Limits Related to State Machine Executions</a> in the <i>AWS Step Functions Developer Guide</i>.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"input":{
"shape":"SensitiveData",
@ -1541,7 +1600,7 @@
"members":{
"name":{
"shape":"Name",
"documentation":"<p>The name of the state.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the state.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"output":{
"shape":"SensitiveData",
@ -1600,7 +1659,7 @@
},
"name":{
"shape":"Name",
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>whitespace</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
"documentation":"<p>The name of the state machine.</p> <p>A name must <i>not</i> contain:</p> <ul> <li> <p>white space</p> </li> <li> <p>brackets <code>&lt; &gt; { } [ ]</code> </p> </li> <li> <p>wildcard characters <code>? *</code> </p> </li> <li> <p>special characters <code>\" # % \\ ^ | ~ ` $ &amp; , ; : /</code> </p> </li> <li> <p>control characters (<code>U+0000-001F</code>, <code>U+007F-009F</code>)</p> </li> </ul>"
},
"creationDate":{
"shape":"Timestamp",
@ -1656,7 +1715,7 @@
"documentation":"<p>The value of a tag.</p>"
}
},
"documentation":"<p>Tags are key-value pairs that can be associated with Step Functions state machines and activities.</p>"
"documentation":"<p>Tags are key-value pairs that can be associated with Step Functions state machines and activities.</p> <p>An array of key-value pairs. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>, and <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html\">Controlling Access Using IAM Tags</a>.</p> <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>"
},
"TagKey":{
"type":"string",
@ -1684,7 +1743,7 @@
},
"tags":{
"shape":"TagList",
"documentation":"<p>The list of tags to add to a resource.</p> <p>Tags may only contain unicode letters, digits, whitespace, or these symbols: <code>_ . : / = + - @</code>.</p>"
"documentation":"<p>The list of tags to add to a resource.</p> <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>"
}
}
},
@ -1927,6 +1986,10 @@
"documentation":"<p>You've exceeded the number of tags allowed for a resource. See the <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/limits.html\"> Limits Topic</a> in the AWS Step Functions Developer Guide.</p>",
"exception":true
},
"UnsignedInteger":{
"type":"integer",
"min":0
},
"UntagResourceInput":{
"type":"structure",
"required":[

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

@ -24,7 +24,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>.</p> <note> <p>You must turn on the gateway VM before you can activate your gateway.</p> </note>"
"documentation":"<p>Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see <a>UpdateGatewayInformation</a>.</p> <note> <p>You must turn on the gateway VM before you can activate your gateway.</p> </note>"
},
"AddCache":{
"name":"AddCache",
@ -164,7 +164,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 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>"
"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 AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide. </p> <p>File gateway does not support creating hard or symbolic links on a file share.</p> </important>"
},
"CreateSMBFileShare":{
"name":"CreateSMBFileShare",
@ -670,7 +670,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).</p> <p>By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.</p> <p>If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.</p>"
"documentation":"<p>Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).</p> <p>By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.</p> <p>If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.</p>"
},
"ListLocalDisks":{
"name":"ListLocalDisks",
@ -768,7 +768,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 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>"
"documentation":"<p>Sends you notification through CloudWatch Events when all files written to your 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 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",
@ -1006,7 +1006,7 @@
{"shape":"InvalidGatewayRequestException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.</p>"
"documentation":"<p>Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.</p> <note> <p>This API is called Security level in the User Guide.</p> <p>A higher security level can affect performance of the gateway.</p> </note>"
},
"UpdateSnapshotSchedule":{
"name":"UpdateSnapshotSchedule",
@ -1061,7 +1061,7 @@
},
"GatewayRegion":{
"shape":"RegionId",
"documentation":"<p>A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your <code>Host</code> header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p> <p> Valid Values: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">AWS Storage Gateway Regions and Endpoints</a> in the AWS General Reference. </p>"
"documentation":"<p>A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your <code>Host</code> header in the request. For more information about available AWS Regions and endpoints for AWS Storage Gateway, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">Regions and Endpoints</a> in the <i>Amazon Web Services Glossary</i>.</p> <p> Valid Values: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#sg_region\">AWS Storage Gateway Regions and Endpoints</a> in the AWS General Reference. </p>"
},
"GatewayType":{
"shape":"GatewayType",
@ -1077,7 +1077,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A list of up to 50 tags that can be assigned to the gateway. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</p> </note>"
"documentation":"<p>A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.</p> </note>"
}
},
"documentation":"<p>A JSON object containing one or more of the following fields:</p> <ul> <li> <p> <a>ActivateGatewayInput$ActivationKey</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayName</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayRegion</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayTimezone</a> </p> </li> <li> <p> <a>ActivateGatewayInput$GatewayType</a> </p> </li> <li> <p> <a>ActivateGatewayInput$TapeDriveType</a> </p> </li> <li> <p> <a>ActivateGatewayInput$MediumChangerType</a> </p> </li> </ul>"
@ -1087,7 +1087,7 @@
"members":{
"GatewayARN":{"shape":"GatewayARN"}
},
"documentation":"<p>AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.</p> <note> <p>For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.</p> </note>"
"documentation":"<p>AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and AWS Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.</p> <note> <p>For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.</p> </note>"
},
"ActivationKey":{
"type":"string",
@ -1421,6 +1421,10 @@
"max":100,
"min":5
},
"CloudWatchLogGroupARN":{
"type":"string",
"max":562
},
"CreateCachediSCSIVolumeInput":{
"type":"structure",
"required":[
@ -1466,7 +1470,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A list of up to 50 tags that can be assigned to a cached volume. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</p> </note>"
"documentation":"<p>A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.</p> </note>"
}
}
},
@ -1624,7 +1628,7 @@
},
"AdminUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users or groups in the Active Directory that have administrator rights to 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>A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. </p> <important> <p>Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.</p> </important>"
},
"ValidUserList":{
"shape":"FileShareUserList",
@ -1669,6 +1673,10 @@
"SnapshotDescription":{
"shape":"SnapshotDescription",
"documentation":"<p>Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the <b>Description</b> field, and in the AWS Storage Gateway snapshot <b>Details</b> pane, <b>Description</b> field</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.</p> </note>"
}
}
},
@ -1799,7 +1807,7 @@
"members":{
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</p>"
"documentation":"<p>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</p>"
},
"TapeSizeInBytes":{
"shape":"TapeSize",
@ -1850,7 +1858,7 @@
"members":{
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</p>"
"documentation":"<p>The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</p>"
},
"TapeSizeInBytes":{
"shape":"TapeSize",
@ -2051,7 +2059,7 @@
"members":{
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</p>"
"documentation":"<p>The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</p>"
},
"TapeARN":{
"shape":"TapeARN",
@ -2251,6 +2259,10 @@
"VPCEndpoint":{
"shape":"string",
"documentation":"<p>The configuration settings for the virtual private cloud (VPC) endpoint for your gateway. </p>"
},
"CloudWatchLogGroupARN":{
"shape":"CloudWatchLogGroupARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the gateway.</p>"
}
},
"documentation":"<p>A JSON object containing the following fields:</p>"
@ -2353,7 +2365,7 @@
},
"SMBSecurityStrategy":{
"shape":"SMBSecurityStrategy",
"documentation":"<p>The type of security strategy that was specified for file gateway.</p> <p>ClientSpecified: SMBv1 is enabled, SMB signing is offered but not required, SMB encryption is offered but not required.</p> <p>MandatorySigning: SMBv1 is disabled, SMB signing is required, SMB encryption is offered but not required.</p> <p>MandatoryEncryption: SMBv1 is disabled, SMB signing is offered but not required, SMB encryption is required.</p>"
"documentation":"<p>The type of security strategy that was specified for file gateway.</p> <p>ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. </p> <p>MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. </p> <p>MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer. </p>"
}
}
},
@ -2390,6 +2402,10 @@
"Timezone":{
"shape":"GatewayTimezone",
"documentation":"<p>A value that indicates the time zone of the gateway.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the <code>ListTagsForResource</code> API operation.</p>"
}
}
},
@ -2901,7 +2917,7 @@
},
"GatewayARN":{
"type":"string",
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</p>",
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</p>",
"max":500,
"min":50
},
@ -2919,7 +2935,7 @@
},
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</p>"
},
"GatewayType":{
"shape":"GatewayType",
@ -3052,7 +3068,7 @@
"members":{
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and region.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and AWS Region.</p>"
},
"DomainName":{
"shape":"DomainName",
@ -3060,7 +3076,7 @@
},
"OrganizationalUnit":{
"shape":"OrganizationalUnit",
"documentation":"<p>The organizational unit (OU) is a container with an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.</p>"
"documentation":"<p>The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.</p>"
},
"DomainControllers":{
"shape":"Hosts",
@ -3596,7 +3612,7 @@
},
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</p> <p>You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</p> <p>You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.</p>"
}
},
"documentation":"<p>RetrieveTapeArchiveInput</p>"
@ -4088,7 +4104,7 @@
},
"GatewayARN":{
"shape":"GatewayARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and region.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and AWS Region.</p>"
},
"PoolId":{
"shape":"PoolId",
@ -4221,6 +4237,10 @@
"GatewayTimezone":{
"shape":"GatewayTimezone",
"documentation":"<p>A value that indicates the time zone of the gateway.</p>"
},
"CloudWatchLogGroupARN":{
"shape":"CloudWatchLogGroupARN",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html\">What Is Amazon CloudWatch Logs?</a>.</p>"
}
}
},
@ -4388,7 +4408,7 @@
},
"AdminUserList":{
"shape":"FileShareUserList",
"documentation":"<p>A list of users or groups in the Active Directory that have administrator rights to 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>A list of users in the Active Directory that have administrator rights to 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>"
},
"ValidUserList":{
"shape":"FileShareUserList",
@ -4421,7 +4441,7 @@
"GatewayARN":{"shape":"GatewayARN"},
"SMBSecurityStrategy":{
"shape":"SMBSecurityStrategy",
"documentation":"<p>Specifies the type of security strategy.</p> <p>ClientSpecified: SMBv1 is enabled, SMB signing is offered but not required, SMB encryption is offered but not required.</p> <p>MandatorySigning: SMBv1 is disabled, SMB signing is required, SMB encryption is offered but not required.</p> <p>MandatoryEncryption: SMBv1 is disabled, SMB signing is offered but not required, SMB encryption is required.</p>"
"documentation":"<p>Specifies the type of security strategy.</p> <p>ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. </p> <p>MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer. </p> <p>MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer. </p>"
}
}
},
@ -4669,5 +4689,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 the AWS 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=\"https://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=\"https://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=\"https://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=\"https://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>"
"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 the AWS 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=\"https://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=\"https://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=\"https://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=\"https://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 the 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>"
}

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

@ -311,6 +311,12 @@
"exception":true,
"fault":true
},
"KMSKeyId":{
"type":"string",
"max":2048,
"min":1,
"pattern":"^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$"
},
"LanguageCode":{
"type":"string",
"enum":[
@ -327,7 +333,9 @@
"es-ES",
"en-IN",
"hi-IN",
"ar-SA"
"ar-SA",
"ru-RU",
"zh-CN"
]
},
"LimitExceededException":{
@ -450,7 +458,8 @@
},
"NextToken":{
"type":"string",
"max":8192
"max":8192,
"pattern":".+"
},
"NotFoundException":{
"type":"structure",
@ -462,6 +471,7 @@
},
"OutputBucketName":{
"type":"string",
"max":64,
"pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]"
},
"OutputLocationType":{
@ -474,7 +484,8 @@
"Phrase":{
"type":"string",
"max":256,
"min":0
"min":0,
"pattern":".+"
},
"Phrases":{
"type":"list",
@ -507,7 +518,6 @@
"required":[
"TranscriptionJobName",
"LanguageCode",
"MediaFormat",
"Media"
],
"members":{
@ -521,7 +531,7 @@
},
"MediaSampleRateHertz":{
"shape":"MediaSampleRateHertz",
"documentation":"<p>The sample rate, in Hertz, of the audio track in the input media file. </p>"
"documentation":"<p>The sample rate, in Hertz, of the audio track in the input media file. </p> <p>If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the <code>MediaSampleRateHertz</code> field blank and let Amazon Transcribe determine the sample rate.</p>"
},
"MediaFormat":{
"shape":"MediaFormat",
@ -533,8 +543,9 @@
},
"OutputBucketName":{
"shape":"OutputBucketName",
"documentation":"<p>The location where the transcription is stored.</p> <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/access-control-managing-permissions.html#auth-role-iam-user\">Permissions Required for IAM User Roles</a>.</p> <p>Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.</p> <p>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</p>"
"documentation":"<p>The location where the transcription is stored.</p> <p>If you set the <code>OutputBucketName</code>, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the <a>GetTranscriptionJob</a> operation, the operation returns this location in the <code>TranscriptFileUri</code> field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see <a href=\"https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user\">Permissions Required for IAM User Roles</a>.</p> <p>Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.</p> <p>If you don't set the <code>OutputBucketName</code>, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the <code>TranscriptFileUri</code> field. Use this URL to download the transcription.</p>"
},
"OutputEncryptionKMSKeyId":{"shape":"KMSKeyId"},
"Settings":{
"shape":"Settings",
"documentation":"<p>A <code>Settings</code> object that provides optional settings for a transcription job.</p>"
@ -661,7 +672,7 @@
"documentation":"<p>Indicates the location of the output of the transcription job.</p> <p>If the value is <code>CUSTOMER_BUCKET</code> then the location is the S3 bucket specified in the <code>outputBucketName</code> field when the transcription job was started with the <code>StartTranscriptionJob</code> operation.</p> <p>If the value is <code>SERVICE_BUCKET</code> then the output is stored by Amazon Transcribe and can be retrieved using the URI in the <code>GetTranscriptionJob</code> response's <code>TranscriptFileUri</code> field.</p>"
}
},
"documentation":"<p>Provides a summary of information about a transcription job. .</p>"
"documentation":"<p>Provides a summary of information about a transcription job.</p>"
},
"UpdateVocabularyRequest":{
"type":"structure",
@ -712,7 +723,8 @@
"Uri":{
"type":"string",
"max":2000,
"min":1
"min":1,
"pattern":"(s3://|http(s*)://).+"
},
"Vocabularies":{
"type":"list",

111
botocore/data/transfer/2018-11-05/service-2.json
View file

@ -28,7 +28,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ResourceExistsException"}
],
"documentation":"<p>Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the <code>ServerId</code> property assigned by the service to the newly created server. Reference this <code>ServerId</code> property when you make updates to your server, or work with users.</p> <p>The response returns the <code>ServerId</code> value for the newly created server.</p>"
"documentation":"<p>Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. When you make updates to your server or when you work with users, use the service-generated <code>ServerId</code> property that is assigned to the newly created server.</p>"
},
"CreateUser":{
"name":"CreateUser",
@ -45,7 +45,7 @@
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds a user and associate them with an existing Secure File Transfer Protocol (SFTP) server. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.</p> <p>The response returns the <code>UserName</code> and <code>ServerId</code> values of the new user for that server.</p>"
"documentation":"<p>Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP) server. You can only create and associate users with SFTP servers that have the <code>IdentityProviderType</code> set to <code>SERVICE_MANAGED</code>. Using parameters for <code>CreateUser</code>, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.</p>"
},
"DeleteServer":{
"name":"DeleteServer",
@ -60,7 +60,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the Secure File Transfer Protocol (SFTP) server that you specify. If you used <code>SERVICE_MANAGED</code> as your <code>IdentityProviderType</code>, you need to delete all users associated with this server before deleting the server itself</p> <p>No response returns from this call.</p>"
"documentation":"<p>Deletes the Secure File Transfer Protocol (SFTP) server that you specify.</p> <p>No response returns from this operation.</p>"
},
"DeleteSshPublicKey":{
"name":"DeleteSshPublicKey",
@ -75,7 +75,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a user's Secure Shell (SSH) public key.</p> <p>No response is returned from this call.</p>"
"documentation":"<p>Deletes a user's Secure Shell (SSH) public key.</p> <p>No response is returned from this operation.</p>"
},
"DeleteUser":{
"name":"DeleteUser",
@ -90,7 +90,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the user belonging to the server you specify.</p> <p>No response returns from this call.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note>"
"documentation":"<p>Deletes the user belonging to the server you specify.</p> <p>No response returns from this operation.</p> <note> <p>When you delete a user from a server, the user's information is lost.</p> </note>"
},
"DescribeServer":{
"name":"DescribeServer",
@ -218,7 +218,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Changes the state of an SFTP server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.</p> <p>The states of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>"
"documentation":"<p>Changes the state of an SFTP server from <code>ONLINE</code> to <code>OFFLINE</code>. An <code>OFFLINE</code> server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.</p> <p>The state of <code>STOPPING</code> indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>STOP_FAILED</code> can indicate an error condition.</p> <p>No response is returned from this call.</p>"
},
"TagResource":{
"name":"TagResource",
@ -248,7 +248,7 @@
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>If the <code>IdentityProviderType</code> of the server is <code>API_Gateway</code>, tests whether your API Gateway is set up successfully. We highly recommend that you call this method to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.</p>"
"documentation":"<p>If the <code>IdentityProviderType</code> of the server is <code>API_Gateway</code>, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -308,23 +308,23 @@
"members":{
"EndpointDetails":{
"shape":"EndpointDetails",
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server.</p>"
"documentation":"<p>The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the <code>EndpointType</code> parameter.</p>"
},
"EndpointType":{
"shape":"EndpointType",
"documentation":"<p>The type of VPC endpoint that you want your SFTP server connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>"
"documentation":"<p>The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.</p>"
},
"HostKey":{
"shape":"HostKey",
"documentation":"<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -f my-new-server-key</code> command.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see <a>change-host-key</a> in the <i>AWS SFTP User Guide.</i> </p> </important>"
"documentation":"<p>The RSA private key as generated by the <code>ssh-keygen -N \"\" -f my-new-server-key</code> command.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.</p> </important> <p> For more information, see \"https://docs.aws.amazon.com/transfer/latest/userguide/change-host-key\" in the <i>AWS SFTP User Guide.</i> </p>"
},
"IdentityProviderDetails":{
"shape":"IdentityProviderDetails",
"documentation":"<p>An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the <code>IdentityProviderType</code> value of server that is created uses the <code>SERVICE_MANAGED</code> authentication method.</p>"
"documentation":"<p>This parameter is required when the <code>IdentityProviderType</code> is set to <code>API_GATEWAY</code>. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the <code>IdentityProviderType</code> is set to <code>SERVICE_MANAGED</code>.</p>"
},
"IdentityProviderType":{
"shape":"IdentityProviderType",
"documentation":"<p>The mode of authentication enabled for this service. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access SFTP user credentials within the service. An <code>IdentityProviderType</code> value of <code>API_GATEWAY</code> indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.</p>"
"documentation":"<p>Specifies the mode of authentication for the SFTP server. The default value is <code>SERVICE_MANAGED</code>, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the <code>API_GATEWAY</code> value to integrate with an identity provider of your choosing. The <code>API_GATEWAY</code> setting requires you to provide an API Gateway endpoint URL to call for authentication using the <code>IdentityProviderDetails</code> parameter.</p>"
},
"LoggingRole":{
"shape":"Role",
@ -360,7 +360,7 @@
},
"Policy":{
"shape":"Policy",
"documentation":"<p>A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>"
"documentation":"<p>A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\"&gt;Creating a Scope-Down Policy.</p> <p>For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the <i>AWS Security Token Service API Reference</i>.</p> </note>"
},
"Role":{
"shape":"Role",
@ -372,7 +372,7 @@
},
"SshPublicKeyBody":{
"shape":"SshPublicKeyBody",
"documentation":"<p>The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.</p>"
"documentation":"<p>The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.</p>"
},
"Tags":{
"shape":"Tags",
@ -484,7 +484,7 @@
},
"UserName":{
"shape":"UserName",
"documentation":"<p>The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer service and perform file transfer tasks.</p>"
"documentation":"<p>The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.</p>"
}
}
},
@ -523,7 +523,7 @@
},
"HostKeyFingerprint":{
"shape":"HostKeyFingerprint",
"documentation":"<p>This value contains the Message-Digest Algorithm (MD5) hash of the server's host key. This value is equivalent to the output of <code>ssh-keygen -l -E md5 -f my-new-server-key</code> command.</p>"
"documentation":"<p>This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the <code>ssh-keygen -l -E md5 -f my-new-server-key</code> command.</p>"
},
"IdentityProviderDetails":{
"shape":"IdentityProviderDetails",
@ -531,19 +531,19 @@
},
"IdentityProviderType":{
"shape":"IdentityProviderType",
"documentation":"<p>This property defines the mode of authentication method enabled for this service. A value of <code>SERVICE_MANAGED</code>, means that you are using this Server to store and access SFTP user credentials within the service. A value of <code>API_GATEWAY</code> indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.</p>"
"documentation":"<p>This property defines the mode of authentication method enabled for this service. A value of <code>SERVICE_MANAGED</code> means that you are using this server to store and access SFTP user credentials within the service. A value of <code>API_GATEWAY</code> indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.</p>"
},
"LoggingRole":{
"shape":"Role",
"documentation":"<p>This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.</p>"
"documentation":"<p>This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.</p>"
},
"ServerId":{
"shape":"ServerId",
"documentation":"<p>This property is a unique system assigned identifier for the SFTP server that you instantiate.</p>"
"documentation":"<p>This property is a unique system-assigned identifier for the SFTP server that you instantiate.</p>"
},
"State":{
"shape":"State",
"documentation":"<p>The condition of the SFTP server for the server that was described. A value of <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>"
"documentation":"<p>The condition of the SFTP server for the server that was described. A value of <code>ONLINE</code> indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>"
},
"Tags":{
"shape":"Tags",
@ -554,7 +554,7 @@
"documentation":"<p>The number of users that are assigned to the SFTP server you specified with the <code>ServerId</code>.</p>"
}
},
"documentation":"<p>Describe the properties of the server that was specified. Information returned includes: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, server Id and state, and assigned tags or metadata. </p>"
"documentation":"<p>Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata. </p>"
},
"DescribedUser":{
"type":"structure",
@ -566,7 +566,7 @@
},
"HomeDirectory":{
"shape":"HomeDirectory",
"documentation":"<p>This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: <code>/<i>bucket_name</i>/home/<i>username</i> </code>.</p>"
"documentation":"<p>This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is <code>/<i>bucket_name</i>/home/<i>username</i> </code>.</p>"
},
"Policy":{
"shape":"Policy",
@ -589,7 +589,7 @@
"documentation":"<p>This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.</p>"
}
},
"documentation":"<p>Returns properties of the user that you wish to describe.</p>"
"documentation":"<p>Returns properties of the user that you want to describe.</p>"
},
"EndpointDetails":{
"type":"structure",
@ -615,7 +615,8 @@
},
"HostKey":{
"type":"string",
"max":4096
"max":4096,
"sensitive":true
},
"HostKeyFingerprint":{"type":"string"},
"IdentityProviderDetails":{
@ -623,18 +624,18 @@
"members":{
"Url":{
"shape":"Url",
"documentation":"<p>The <code>IdentityProviderDetail</code> parameter contains the location of the service endpoint used to authenticate users.</p>"
"documentation":"<p>The <code>Url</code> parameter provides contains the location of the service endpoint used to authenticate users.</p>"
},
"InvocationRole":{
"shape":"Role",
"documentation":"<p>The <code>Role</code> parameter provides the type of <code>InvocationRole</code> used to authenticate the user account.</p>"
"documentation":"<p>The <code>InvocationRole</code> parameter provides the type of <code>InvocationRole</code> used to authenticate the user account.</p>"
}
},
"documentation":"<p>Returns information related to the type of user authentication that is in use for a server's users. A server can only have one method of authentication.</p>"
"documentation":"<p>Returns information related to the type of user authentication that is in use for a server's users. A server can have only one method of authentication.</p>"
},
"IdentityProviderType":{
"type":"string",
"documentation":"<p>Returns information related to the type of user authentication that is in use for a server's users. For <code>SERVICE_MANAGED</code> authentication, the Secure Shell (SSH) public keys are stored with a user on an SFTP server instance. For <code>API_GATEWAY</code> authentication, your custom authentication method is implemented by using an API call. A server can only have one method of authentication.</p>",
"documentation":"<p>Returns information related to the type of user authentication that is in use for a server's users. For <code>SERVICE_MANAGED</code> authentication, the Secure Shell (SSH) public keys are stored with a user on an SFTP server instance. For <code>API_GATEWAY</code> authentication, your custom authentication method is implemented by using an API call. A server can have only one method of authentication.</p>",
"enum":[
"SERVICE_MANAGED",
"API_GATEWAY"
@ -683,7 +684,7 @@
"documentation":"<p>A user name assigned to the <code>ServerID</code> value that you specified.</p>"
}
},
"documentation":"<p>This response identifies the user, server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associate with.</p>"
"documentation":"<p>This response identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.</p>"
},
"InternalServiceError":{
"type":"structure",
@ -722,7 +723,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When additional results are obtained from the ListServers command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional servers.</p>"
"documentation":"<p>When additional results are obtained from the <code>ListServers</code> command, a <code>NextToken</code> parameter is returned in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional servers.</p>"
}
}
},
@ -754,7 +755,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When you request additional results from the <code>ListTagsForResource</code> call, a <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent command the <code>NextToken</code> parameter to continue listing additional tags.</p>"
"documentation":"<p>When you request additional results from the <code>ListTagsForResource</code> operation, a <code>NextToken</code> parameter is returned in the input. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags.</p>"
}
}
},
@ -767,11 +768,11 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When you can get additional results from the <code>ListTagsForResource</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command the <code>NextToken</code> parameter to continue listing additional tags.</p>"
"documentation":"<p>When you can get additional results from the <code>ListTagsForResource</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional tags.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define that you can use for any purpose.</p>"
"documentation":"<p>Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.</p>"
}
}
},
@ -785,11 +786,11 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command the <code>NextToken</code> parameter to continue listing additional users.</p>"
"documentation":"<p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users.</p>"
},
"ServerId":{
"shape":"ServerId",
"documentation":"<p>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.</p>"
"documentation":"<p>A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users assigned to it.</p>"
}
}
},
@ -802,7 +803,7 @@
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command the <code>NextToken</code> parameter to continue listing additional users.</p>"
"documentation":"<p>When you can get additional results from the <code>ListUsers</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional users.</p>"
},
"ServerId":{
"shape":"ServerId",
@ -824,7 +825,7 @@
},
"IdentityProviderType":{
"shape":"IdentityProviderType",
"documentation":"<p>The authentication method used to validate a user for the server that was specified. listed. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include <code>SERVICE_MANAGED</code> or <code>API_GATEWAY</code>.</p>"
"documentation":"<p>The authentication method used to validate a user for the server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include <code>SERVICE_MANAGED</code> or <code>API_GATEWAY</code>.</p>"
},
"EndpointType":{
"shape":"EndpointType",
@ -840,7 +841,7 @@
},
"State":{
"shape":"State",
"documentation":"<p>This property describes the condition of the SFTP server for the server that was described. A value of <code>ONLINE</code>&gt; indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicated that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>"
"documentation":"<p>This property describes the condition of the SFTP server for the server that was described. A value of <code>ONLINE</code>&gt; indicates that the server can accept jobs and transfer files. A <code>State</code> value of <code>OFFLINE</code> means that the server cannot perform file transfer operations.</p> <p>The states of <code>STARTING</code> and <code>STOPPING</code> indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of <code>START_FAILED</code> or <code>STOP_FAILED</code> can indicate an error condition.</p>"
},
"UserCount":{
"shape":"UserCount",
@ -859,7 +860,7 @@
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>This property is the unique Amazon Resource Name (ARN) for the user that you wish to learn about.</p>"
"documentation":"<p>This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.</p>"
},
"HomeDirectory":{
"shape":"HomeDirectory",
@ -867,7 +868,7 @@
},
"Role":{
"shape":"Role",
"documentation":"<p>The role in use by this user. A <i>role</i> is an AWS Identity and Access Management (IAM) entity that in this case allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.</p>"
"documentation":"<p>The role in use by this user. A <i>role</i> is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.</p>"
},
"SshPublicKeyCount":{
"shape":"SshPublicKeyCount",
@ -932,6 +933,7 @@
"exception":true
},
"ResourceType":{"type":"string"},
"Response":{"type":"string"},
"Role":{
"type":"string",
"pattern":"arn:.*role/.*"
@ -1080,11 +1082,11 @@
"members":{
"ServerId":{
"shape":"ServerId",
"documentation":"<p>A system assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.</p>"
"documentation":"<p>A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.</p>"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>This request parameter is name of the user account to be tested.</p>"
"documentation":"<p>This request parameter is the name of the user account to be tested.</p>"
},
"UserPassword":{
"shape":"UserPassword",
@ -1099,14 +1101,18 @@
"Url"
],
"members":{
"Message":{
"shape":"Message",
"documentation":"<p>The result of the authorization test as a message. </p>"
"Response":{
"shape":"Response",
"documentation":"<p>The response that is returned from your API Gateway.</p>"
},
"StatusCode":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status code that is the response from your API Gateway.</p>"
},
"Message":{
"shape":"Message",
"documentation":"<p>A message that indicates whether the test was successful or not. </p>"
},
"Url":{
"shape":"Url",
"documentation":"<p>The endpoint of the service used to authenticate a user.</p>"
@ -1144,7 +1150,7 @@
},
"HostKey":{
"shape":"HostKey",
"documentation":"<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -f my-new-server-key</code>.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive. For more information, see <a>change-host-key</a> in the <i>AWS SFTP User Guide.</i> </p> </important>"
"documentation":"<p>The RSA private key as generated by <code>ssh-keygen -N \"\" -f my-new-server-key</code>.</p> <important> <p>If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.</p> </important> <p> For more information, see \"https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the <i>AWS SFTP User Guide.</i> </p>"
},
"IdentityProviderDetails":{
"shape":"IdentityProviderDetails",
@ -1179,11 +1185,11 @@
"members":{
"HomeDirectory":{
"shape":"HomeDirectory",
"documentation":"<p>The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: <code>/home/<i>username</i> </code>.</p>"
"documentation":"<p>A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client. An example is <code>/home/<i>username</i> </code>.</p>"
},
"Policy":{
"shape":"Policy",
"documentation":"<p>Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p>"
"documentation":"<p>Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include <code>${Transfer:UserName}</code>, <code>${Transfer:HomeDirectory}</code>, and <code>${Transfer:HomeBucket}</code>.</p> <note> <p>For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the <code>Policy</code> argument.</p> <p>For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\"&gt;Creating a Scope-Down Policy.</p> <p>For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the <i>AWS Security Token Service API Reference</i>.</p> </note>"
},
"Role":{
"shape":"Role",
@ -1195,7 +1201,7 @@
},
"UserName":{
"shape":"UserName",
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>"
"documentation":"<p>A unique string that identifies a user and is associated with a server as specified by the <code>ServerId</code>. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.</p>"
}
}
},
@ -1223,11 +1229,14 @@
"type":"string",
"pattern":"^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,31}$"
},
"UserPassword":{"type":"string"},
"UserPassword":{
"type":"string",
"sensitive":true
},
"VpcEndpointId":{
"type":"string",
"pattern":"^vpce-[0-9a-f]{17}$"
}
},
"documentation":"<p>AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and setup. </p>"
"documentation":"<p>AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and set up. </p>"
}

12
botocore/data/waf-regional/2016-11-28/service-2.json
View file

@ -1059,7 +1059,7 @@
{"shape":"WAFStaleDataException"},
{"shape":"WAFServiceLinkedRoleErrorException"}
],
"documentation":"<p>Associates a <a>LoggingConfiguration</a> with a specified web ACL.</p> <p>You can access information about all traffic that AWS WAF inspects using the following steps:</p> <ol> <li> <p>Create an Amazon Kinesis Data Firehose . </p> <p>Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). </p> <note> <p>Do not create the data firehose using a <code>Kinesis stream</code> as your source.</p> </note> </li> <li> <p>Associate that firehose to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging Web ACL Traffic Information</a> in the <i>AWS WAF Developer Guide</i>.</p>"
"documentation":"<p>Associates a <a>LoggingConfiguration</a> with a specified web ACL.</p> <p>You can access information about all traffic that AWS WAF inspects using the following steps:</p> <ol> <li> <p>Create an Amazon Kinesis Data Firehose. </p> <p>Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). </p> <note> <p>Do not create the data firehose using a <code>Kinesis stream</code> as your source.</p> </note> </li> <li> <p>Associate that firehose to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging Web ACL Traffic Information</a> in the <i>AWS WAF Developer Guide</i>.</p>"
},
"PutPermissionPolicy":{
"name":"PutPermissionPolicy",
@ -3163,7 +3163,7 @@
"documentation":"<p>The IP address type (<code>IPV4</code> or <code>IPV6</code>) and the IP address range (in CIDR notation) that web requests originate from. If the <code>WebACL</code> is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.</p>"
}
},
"documentation":"<p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.</p> <p>To specify an individual IP address, you specify the four-part IP address followed by a <code>/32</code>, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p>"
"documentation":"<p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.</p> <p>To specify an individual IP address, you specify the four-part IP address followed by a <code>/32</code>, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p>"
},
"IPSetDescriptor":{
"type":"structure",
@ -3328,7 +3328,7 @@
"members":{
"NextMarker":{
"shape":"NextMarker",
"documentation":"<p>If you specify a value for <code>Limit</code> and you have more <code>IPSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>.</p>"
"documentation":"<p>AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>.</p>"
},
"Limit":{
"shape":"PaginationLimit",
@ -3341,7 +3341,7 @@
"members":{
"NextMarker":{
"shape":"NextMarker",
"documentation":"<p>If you have more <code>IPSet</code> objects than the number that you specified for <code>Limit</code> in the request, the response includes a <code>NextMarker</code> value. To list more <code>IPSet</code> objects, submit another <code>ListIPSets</code> request, and specify the <code>NextMarker</code> value from the response in the <code>NextMarker</code> value in the next request.</p>"
"documentation":"<p>To list more <code>IPSet</code> objects, submit another <code>ListIPSets</code> request, and in the next request use the <code>NextMarker</code> response value as the <code>NextMarker</code> value.</p>"
},
"IPSets":{
"shape":"IPSetSummaries",
@ -3835,7 +3835,7 @@
"members":{
"LoggingConfiguration":{
"shape":"LoggingConfiguration",
"documentation":"<p>The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.</p>"
"documentation":"<p>The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.</p> <note> <p>When specifying <code>Type</code> in <code>RedactedFields</code>, you must use one of the following values: <code>URI</code>, <code>QUERY_STRING</code>, <code>HEADER</code>, or <code>METHOD</code>.</p> </note>"
}
}
},
@ -3913,7 +3913,7 @@
"RateLimit":{
"type":"long",
"max":2000000000,
"min":2000
"min":100
},
"RedactedFields":{
"type":"list",

12
botocore/data/waf/2015-08-24/service-2.json
View file

@ -993,7 +993,7 @@
{"shape":"WAFStaleDataException"},
{"shape":"WAFServiceLinkedRoleErrorException"}
],
"documentation":"<p>Associates a <a>LoggingConfiguration</a> with a specified web ACL.</p> <p>You can access information about all traffic that AWS WAF inspects using the following steps:</p> <ol> <li> <p>Create an Amazon Kinesis Data Firehose . </p> <p>Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). </p> <note> <p>Do not create the data firehose using a <code>Kinesis stream</code> as your source.</p> </note> </li> <li> <p>Associate that firehose to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging Web ACL Traffic Information</a> in the <i>AWS WAF Developer Guide</i>.</p>"
"documentation":"<p>Associates a <a>LoggingConfiguration</a> with a specified web ACL.</p> <p>You can access information about all traffic that AWS WAF inspects using the following steps:</p> <ol> <li> <p>Create an Amazon Kinesis Data Firehose. </p> <p>Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). </p> <note> <p>Do not create the data firehose using a <code>Kinesis stream</code> as your source.</p> </note> </li> <li> <p>Associate that firehose to your web ACL using a <code>PutLoggingConfiguration</code> request.</p> </li> </ol> <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/logging.html\">Logging Web ACL Traffic Information</a> in the <i>AWS WAF Developer Guide</i>.</p>"
},
"PutPermissionPolicy":{
"name":"PutPermissionPolicy",
@ -3041,7 +3041,7 @@
"documentation":"<p>The IP address type (<code>IPV4</code> or <code>IPV6</code>) and the IP address range (in CIDR notation) that web requests originate from. If the <code>WebACL</code> is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.</p>"
}
},
"documentation":"<p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.</p> <p>To specify an individual IP address, you specify the four-part IP address followed by a <code>/32</code>, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p>"
"documentation":"<p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.</p> <p>To specify an individual IP address, you specify the four-part IP address followed by a <code>/32</code>, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry <a href=\"https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p>"
},
"IPSetDescriptor":{
"type":"structure",
@ -3206,7 +3206,7 @@
"members":{
"NextMarker":{
"shape":"NextMarker",
"documentation":"<p>If you specify a value for <code>Limit</code> and you have more <code>IPSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>.</p>"
"documentation":"<p>AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>.</p>"
},
"Limit":{
"shape":"PaginationLimit",
@ -3219,7 +3219,7 @@
"members":{
"NextMarker":{
"shape":"NextMarker",
"documentation":"<p>If you have more <code>IPSet</code> objects than the number that you specified for <code>Limit</code> in the request, the response includes a <code>NextMarker</code> value. To list more <code>IPSet</code> objects, submit another <code>ListIPSets</code> request, and specify the <code>NextMarker</code> value from the response in the <code>NextMarker</code> value in the next request.</p>"
"documentation":"<p>To list more <code>IPSet</code> objects, submit another <code>ListIPSets</code> request, and in the next request use the <code>NextMarker</code> response value as the <code>NextMarker</code> value.</p>"
},
"IPSets":{
"shape":"IPSetSummaries",
@ -3690,7 +3690,7 @@
"members":{
"LoggingConfiguration":{
"shape":"LoggingConfiguration",
"documentation":"<p>The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.</p>"
"documentation":"<p>The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.</p> <note> <p>When specifying <code>Type</code> in <code>RedactedFields</code>, you must use one of the following values: <code>URI</code>, <code>QUERY_STRING</code>, <code>HEADER</code>, or <code>METHOD</code>.</p> </note>"
}
}
},
@ -3768,7 +3768,7 @@
"RateLimit":{
"type":"long",
"max":2000000000,
"min":2000
"min":100
},
"RedactedFields":{
"type":"list",

3
botocore/data/workmailmessageflow/2019-05-01/paginators-1.json Normal file
View file

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

74
botocore/data/workmailmessageflow/2019-05-01/service-2.json Normal file
View file

@ -0,0 +1,74 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2019-05-01",
"endpointPrefix":"workmailmessageflow",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"Amazon WorkMail Message Flow",
"serviceId":"WorkMailMessageFlow",
"signatureVersion":"v4",
"uid":"workmailmessageflow-2019-05-01"
},
"operations":{
"GetRawMessageContent":{
"name":"GetRawMessageContent",
"http":{
"method":"GET",
"requestUri":"/messages/{messageId}"
},
"input":{"shape":"GetRawMessageContentRequest"},
"output":{"shape":"GetRawMessageContentResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves the raw content of an in-transit email message, in MIME format. </p>"
}
},
"shapes":{
"GetRawMessageContentRequest":{
"type":"structure",
"required":["messageId"],
"members":{
"messageId":{
"shape":"messageIdType",
"documentation":"<p>The identifier of the email message to retrieve.</p>",
"location":"uri",
"locationName":"messageId"
}
}
},
"GetRawMessageContentResponse":{
"type":"structure",
"required":["messageContent"],
"members":{
"messageContent":{
"shape":"messageContentBlob",
"documentation":"<p>The raw content of the email message, in MIME format.</p>"
}
},
"payload":"messageContent"
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
},
"documentation":"<p>The requested email message is not found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"errorMessage":{"type":"string"},
"messageContentBlob":{
"type":"blob",
"streaming":true
},
"messageIdType":{
"type":"string",
"max":120,
"min":1,
"pattern":"[a-z0-9\\-]*"
}
},
"documentation":"<p>The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.</p>"
}

85
botocore/data/workspaces/2015-04-08/service-2.json
View file

@ -264,6 +264,21 @@
],
"documentation":"<p>Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. </p>"
},
"DescribeWorkspaceSnapshots":{
"name":"DescribeWorkspaceSnapshots",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceSnapshotsRequest"},
"output":{"shape":"DescribeWorkspaceSnapshotsResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Describes the snapshots for the specified WorkSpace.</p>"
},
"DescribeWorkspaces":{
"name":"DescribeWorkspaces",
"http":{
@ -425,6 +440,21 @@
"output":{"shape":"RebuildWorkspacesResult"},
"documentation":"<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, or <code>UNHEALTHY</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html\">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>"
},
"RestoreWorkspace":{
"name":"RestoreWorkspace",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RestoreWorkspaceRequest"},
"output":{"shape":"RestoreWorkspaceResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Restores the specified WorkSpace to its last known healthy state.</p> <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>, <code>ERROR</code>, or <code>UNHEALTHY</code>.</p> <p>Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html\">Restore a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpace is completely restored.</p>"
},
"RevokeIpRules":{
"name":"RevokeIpRules",
"http":{
@ -1071,6 +1101,29 @@
}
}
},
"DescribeWorkspaceSnapshotsRequest":{
"type":"structure",
"required":["WorkspaceId"],
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace.</p>"
}
}
},
"DescribeWorkspaceSnapshotsResult":{
"type":"structure",
"members":{
"RebuildSnapshots":{
"shape":"SnapshotList",
"documentation":"<p>Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the root volume.</p>"
},
"RestoreSnapshots":{
"shape":"SnapshotList",
"documentation":"<p>Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.</p>"
}
}
},
"DescribeWorkspacesConnectionStatusRequest":{
"type":"structure",
"members":{
@ -1245,7 +1298,7 @@
"documentation":"<p>The text of the error message that is returned if the WorkSpace cannot be rebooted.</p>"
}
},
"documentation":"<p>Describes a WorkSpace that could not be rebooted. (<a>RebootWorkspaces</a>), rebuilt (<a>RebuildWorkspaces</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>"
"documentation":"<p>Describes a WorkSpace that could not be rebooted. (<a>RebootWorkspaces</a>), rebuilt (<a>RebuildWorkspaces</a>), restored (<a>RestoreWorkspace</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>"
},
"ImportWorkspaceImageRequest":{
"type":"structure",
@ -1706,6 +1759,21 @@
"documentation":"<p>The specified resource is not available.</p>",
"exception":true
},
"RestoreWorkspaceRequest":{
"type":"structure",
"required":["WorkspaceId"],
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace.</p>"
}
}
},
"RestoreWorkspaceResult":{
"type":"structure",
"members":{
}
},
"RevokeIpRulesRequest":{
"type":"structure",
"required":[
@ -1751,6 +1819,20 @@
"type":"string",
"pattern":"^(sg-[0-9a-f]{8})$"
},
"Snapshot":{
"type":"structure",
"members":{
"SnapshotTime":{
"shape":"Timestamp",
"documentation":"<p>The time when the snapshot was created.</p>"
}
},
"documentation":"<p>Describes a snapshot.</p>"
},
"SnapshotList":{
"type":"list",
"member":{"shape":"Snapshot"}
},
"StartRequest":{
"type":"structure",
"members":{
@ -2341,6 +2423,7 @@
"REBOOTING",
"STARTING",
"REBUILDING",
"RESTORING",
"MAINTENANCE",
"ADMIN_MAINTENANCE",
"TERMINATING",

2
docs/source/conf.py
View file

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

2
requirements.txt
View file

@ -2,6 +2,6 @@ tox>=2.5.0,<3.0.0
nose==1.3.7
mock==1.3.0
wheel==0.24.0
docutils>=0.10,<0.15
docutils>=0.10,<0.16
behave==1.2.5
jsonschema==2.5.1

2
setup.cfg
View file

@ -6,7 +6,7 @@ requires-dist =
python-dateutil>=2.1,<2.7.0; python_version=="2.6"
python-dateutil>=2.1,<3.0.0; python_version>="2.7"
jmespath>=0.7.1,<1.0.0
docutils>=0.10,<0.15
docutils>=0.10,<0.16
ordereddict==1.1; python_version=="2.6"
simplejson==3.3.0; python_version=="2.6"
urllib3>=1.20,<1.23; python_version=="3.3"

2
setup.py
View file

@ -24,7 +24,7 @@ def find_version(*file_paths):
requires = ['jmespath>=0.7.1,<1.0.0',
'docutils>=0.10,<0.15']
'docutils>=0.10,<0.16']
if sys.version_info[:2] == (2, 6):

2
tests/functional/test_waiter_config.py
View file

@ -156,7 +156,7 @@ def _validate_acceptor(acceptor, op_model, waiter_name):
# JMESPath expression against the output. We'll then
# check a few things about this returned search result.
search_result = _search_jmespath_expression(expression, op_model)
if not search_result:
if search_result is None:
raise AssertionError("JMESPath expression did not match "
"anything for waiter '%s': %s"
% (waiter_name, expression))

6
tests/integration/test_ec2.py
View file

@ -64,9 +64,9 @@ class TestEC2Pagination(unittest.TestCase):
self.assertEqual(len(results), 3)
for parsed in results:
reserved_inst_offer = parsed['ReservedInstancesOfferings']
# There should only be one reserved instance offering on each
# page.
self.assertEqual(len(reserved_inst_offer), 1)
# There should be no more than one reserved instance
# offering on each page.
self.assertLessEqual(len(reserved_inst_offer), 1)
def test_can_fall_back_to_old_starting_token(self):
# Using an operation that we know will paginate.