New upstream version 1.17.22+repack
This commit is contained in:
Noah Meyerhans
parent
749b7d74b9
commit
2a1ff430db
2
PKG-INFO
2
PKG-INFO
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.17.9
|
||||
Version: 1.17.22
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ import os
|
|||
import re
|
||||
import logging
|
||||
|
||||
__version__ = '1.17.9'
|
||||
__version__ = '1.17.22'
|
||||
|
||||
|
||||
class NullHandler(logging.Handler):
|
||||
|
|
|
|||
|
|
@ -874,6 +874,7 @@
|
|||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidDeviceException"}
|
||||
],
|
||||
"documentation":"<p>Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).</p>"
|
||||
|
|
@ -4422,7 +4423,6 @@
|
|||
"ClientId",
|
||||
"UserCode",
|
||||
"ProductId",
|
||||
"DeviceSerialNumber",
|
||||
"AmazonId"
|
||||
],
|
||||
"members":{
|
||||
|
|
@ -4445,6 +4445,10 @@
|
|||
"AmazonId":{
|
||||
"shape":"AmazonId",
|
||||
"documentation":"<p>The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.</p>"
|
||||
},
|
||||
"RoomArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The ARN of the room with which to associate your AVS device.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Creates a new Amplify App. </p>"
|
||||
"documentation":"<p> Creates a new Amplify app. </p>"
|
||||
},
|
||||
"CreateBackendEnvironment":{
|
||||
"name":"CreateBackendEnvironment",
|
||||
|
|
@ -45,7 +45,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Creates a new backend environment for an Amplify App. </p>"
|
||||
"documentation":"<p> Creates a new backend environment for an Amplify app. </p>"
|
||||
},
|
||||
"CreateBranch":{
|
||||
"name":"CreateBranch",
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Creates a new Branch for an Amplify App. </p>"
|
||||
"documentation":"<p> Creates a new branch for an Amplify app. </p>"
|
||||
},
|
||||
"CreateDeployment":{
|
||||
"name":"CreateDeployment",
|
||||
|
|
@ -79,7 +79,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Create a deployment for manual deploy apps. (Apps are not connected to repository) </p>"
|
||||
"documentation":"<p> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. </p>"
|
||||
},
|
||||
"CreateDomainAssociation":{
|
||||
"name":"CreateDomainAssociation",
|
||||
|
|
@ -97,7 +97,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Create a new DomainAssociation on an App </p>"
|
||||
"documentation":"<p> Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app </p>"
|
||||
},
|
||||
"CreateWebhook":{
|
||||
"name":"CreateWebhook",
|
||||
|
|
@ -115,7 +115,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Create a new webhook on an App. </p>"
|
||||
"documentation":"<p> Creates a new webhook on an Amplify app. </p>"
|
||||
},
|
||||
"DeleteApp":{
|
||||
"name":"DeleteApp",
|
||||
|
|
@ -132,7 +132,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Delete an existing Amplify App by appId. </p>"
|
||||
"documentation":"<p> Deletes an existing Amplify app specified by an app ID. </p>"
|
||||
},
|
||||
"DeleteBackendEnvironment":{
|
||||
"name":"DeleteBackendEnvironment",
|
||||
|
|
@ -149,7 +149,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Delete backend environment for an Amplify App. </p>"
|
||||
"documentation":"<p> Deletes a backend environment for an Amplify app. </p>"
|
||||
},
|
||||
"DeleteBranch":{
|
||||
"name":"DeleteBranch",
|
||||
|
|
@ -166,7 +166,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Deletes a branch for an Amplify App. </p>"
|
||||
"documentation":"<p> Deletes a branch for an Amplify app. </p>"
|
||||
},
|
||||
"DeleteDomainAssociation":{
|
||||
"name":"DeleteDomainAssociation",
|
||||
|
|
@ -183,7 +183,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Deletes a DomainAssociation. </p>"
|
||||
"documentation":"<p> Deletes a domain association for an Amplify app. </p>"
|
||||
},
|
||||
"DeleteJob":{
|
||||
"name":"DeleteJob",
|
||||
|
|
@ -200,7 +200,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Delete a job, for an Amplify branch, part of Amplify App. </p>"
|
||||
"documentation":"<p> Deletes a job for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"DeleteWebhook":{
|
||||
"name":"DeleteWebhook",
|
||||
|
|
@ -233,7 +233,7 @@
|
|||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Retrieve website access logs for a specific time range via a pre-signed URL. </p>"
|
||||
"documentation":"<p> Returns the website access logs for a specific time range using a presigned URL. </p>"
|
||||
},
|
||||
"GetApp":{
|
||||
"name":"GetApp",
|
||||
|
|
@ -249,7 +249,7 @@
|
|||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Retrieves an existing Amplify App by appId. </p>"
|
||||
"documentation":"<p> Returns an existing Amplify app by appID. </p>"
|
||||
},
|
||||
"GetArtifactUrl":{
|
||||
"name":"GetArtifactUrl",
|
||||
|
|
@ -266,7 +266,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Retrieves artifact info that corresponds to a artifactId. </p>"
|
||||
"documentation":"<p> Returns the artifact info that corresponds to an artifact id. </p>"
|
||||
},
|
||||
"GetBackendEnvironment":{
|
||||
"name":"GetBackendEnvironment",
|
||||
|
|
@ -282,7 +282,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Retrieves a backend environment for an Amplify App. </p>"
|
||||
"documentation":"<p> Returns a backend environment for an Amplify app. </p>"
|
||||
},
|
||||
"GetBranch":{
|
||||
"name":"GetBranch",
|
||||
|
|
@ -298,7 +298,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Retrieves a branch for an Amplify App. </p>"
|
||||
"documentation":"<p> Returns a branch for an Amplify app. </p>"
|
||||
},
|
||||
"GetDomainAssociation":{
|
||||
"name":"GetDomainAssociation",
|
||||
|
|
@ -314,7 +314,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Retrieves domain info that corresponds to an appId and domainName. </p>"
|
||||
"documentation":"<p> Returns the domain information for an Amplify app. </p>"
|
||||
},
|
||||
"GetJob":{
|
||||
"name":"GetJob",
|
||||
|
|
@ -331,7 +331,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Get a job for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> Returns a job for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"GetWebhook":{
|
||||
"name":"GetWebhook",
|
||||
|
|
@ -348,7 +348,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Retrieves webhook info that corresponds to a webhookId. </p>"
|
||||
"documentation":"<p> Returns the webhook information that corresponds to a specified webhook ID. </p>"
|
||||
},
|
||||
"ListApps":{
|
||||
"name":"ListApps",
|
||||
|
|
@ -363,7 +363,7 @@
|
|||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Lists existing Amplify Apps. </p>"
|
||||
"documentation":"<p> Returns a list of the existing Amplify apps. </p>"
|
||||
},
|
||||
"ListArtifacts":{
|
||||
"name":"ListArtifacts",
|
||||
|
|
@ -379,7 +379,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> List artifacts with an app, a branch, a job and an artifact type. </p>"
|
||||
"documentation":"<p> Returns a list of artifacts for a specified app, branch, and job. </p>"
|
||||
},
|
||||
"ListBackendEnvironments":{
|
||||
"name":"ListBackendEnvironments",
|
||||
|
|
@ -394,7 +394,7 @@
|
|||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Lists backend environments for an Amplify App. </p>"
|
||||
"documentation":"<p> Lists the backend environments for an Amplify app. </p>"
|
||||
},
|
||||
"ListBranches":{
|
||||
"name":"ListBranches",
|
||||
|
|
@ -409,7 +409,7 @@
|
|||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Lists branches for an Amplify App. </p>"
|
||||
"documentation":"<p> Lists the branches of an Amplify app. </p>"
|
||||
},
|
||||
"ListDomainAssociations":{
|
||||
"name":"ListDomainAssociations",
|
||||
|
|
@ -424,7 +424,7 @@
|
|||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> List domains with an app </p>"
|
||||
"documentation":"<p> Returns the domain associations for an Amplify app. </p>"
|
||||
},
|
||||
"ListJobs":{
|
||||
"name":"ListJobs",
|
||||
|
|
@ -440,7 +440,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> List Jobs for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> Lists the jobs for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
|
|
@ -455,7 +455,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p> List tags for resource. </p>"
|
||||
"documentation":"<p> Returns a list of tags for a specified Amazon Resource Name (ARN). </p>"
|
||||
},
|
||||
"ListWebhooks":{
|
||||
"name":"ListWebhooks",
|
||||
|
|
@ -471,7 +471,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> List webhooks with an app. </p>"
|
||||
"documentation":"<p> Returns a list of webhooks for an Amplify app. </p>"
|
||||
},
|
||||
"StartDeployment":{
|
||||
"name":"StartDeployment",
|
||||
|
|
@ -488,7 +488,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Start a deployment for manual deploy apps. (Apps are not connected to repository) </p>"
|
||||
"documentation":"<p> Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository. </p>"
|
||||
},
|
||||
"StartJob":{
|
||||
"name":"StartJob",
|
||||
|
|
@ -505,7 +505,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Starts a new job for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> Starts a new job for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"StopJob":{
|
||||
"name":"StopJob",
|
||||
|
|
@ -522,7 +522,7 @@
|
|||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p> Stop a job that is in progress, for an Amplify branch, part of Amplify App. </p>"
|
||||
"documentation":"<p> Stops a job that is in progress for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -537,7 +537,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p> Tag resource with tag key and value. </p>"
|
||||
"documentation":"<p> Tags the resource with a tag key and value. </p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
|
|
@ -552,7 +552,7 @@
|
|||
{"shape":"BadRequestException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p> Untag resource with resourceArn. </p>"
|
||||
"documentation":"<p> Untags a resource with a specified Amazon Resource Name (ARN). </p>"
|
||||
},
|
||||
"UpdateApp":{
|
||||
"name":"UpdateApp",
|
||||
|
|
@ -568,7 +568,7 @@
|
|||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p> Updates an existing Amplify App. </p>"
|
||||
"documentation":"<p> Updates an existing Amplify app. </p>"
|
||||
},
|
||||
"UpdateBranch":{
|
||||
"name":"UpdateBranch",
|
||||
|
|
@ -585,7 +585,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Updates a branch for an Amplify App. </p>"
|
||||
"documentation":"<p> Updates a branch for an Amplify app. </p>"
|
||||
},
|
||||
"UpdateDomainAssociation":{
|
||||
"name":"UpdateDomainAssociation",
|
||||
|
|
@ -602,7 +602,7 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Create a new DomainAssociation on an App </p>"
|
||||
"documentation":"<p> Creates a new domain association for an Amplify app.</p>"
|
||||
},
|
||||
"UpdateWebhook":{
|
||||
"name":"UpdateWebhook",
|
||||
|
|
@ -619,14 +619,15 @@
|
|||
{"shape":"InternalFailureException"},
|
||||
{"shape":"DependentServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Update a webhook. </p>"
|
||||
"documentation":"<p> Updates a webhook. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessToken":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
"min":1,
|
||||
"sensitive":true
|
||||
},
|
||||
"ActiveJobId":{
|
||||
"type":"string",
|
||||
|
|
@ -651,90 +652,94 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for the Amplify App. </p>"
|
||||
"documentation":"<p> The unique ID of the Amplify app. </p>"
|
||||
},
|
||||
"appArn":{
|
||||
"shape":"AppArn",
|
||||
"documentation":"<p> ARN for the Amplify App. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of the Amplify app. </p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p> Name for the Amplify App. </p>"
|
||||
"documentation":"<p> The name for the Amplify app. </p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p> Tag for Amplify App. </p>"
|
||||
"documentation":"<p> The tag for the Amplify app. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for the Amplify App. </p>"
|
||||
"documentation":"<p> The description for the Amplify app. </p>"
|
||||
},
|
||||
"repository":{
|
||||
"shape":"Repository",
|
||||
"documentation":"<p> Repository for the Amplify App. </p>"
|
||||
"documentation":"<p> The repository for the Amplify app. </p>"
|
||||
},
|
||||
"platform":{
|
||||
"shape":"Platform",
|
||||
"documentation":"<p> Platform for the Amplify App. </p>"
|
||||
"documentation":"<p> The platform for the Amplify app. </p>"
|
||||
},
|
||||
"createTime":{
|
||||
"shape":"CreateTime",
|
||||
"documentation":"<p> Create date / time for the Amplify App. </p>"
|
||||
"documentation":"<p> Creates a date and time for the Amplify app. </p>"
|
||||
},
|
||||
"updateTime":{
|
||||
"shape":"UpdateTime",
|
||||
"documentation":"<p> Update date / time for the Amplify App. </p>"
|
||||
"documentation":"<p> Updates the date and time for the Amplify app. </p>"
|
||||
},
|
||||
"iamServiceRoleArn":{
|
||||
"shape":"ServiceRoleArn",
|
||||
"documentation":"<p> IAM service role ARN for the Amplify App. </p>"
|
||||
"documentation":"<p> The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app. </p>"
|
||||
},
|
||||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p> Environment Variables for the Amplify App. </p>"
|
||||
"documentation":"<p> The environment variables for the Amplify app. </p>"
|
||||
},
|
||||
"defaultDomain":{
|
||||
"shape":"DefaultDomain",
|
||||
"documentation":"<p> Default domain for the Amplify App. </p>"
|
||||
"documentation":"<p> The default domain for the Amplify app. </p>"
|
||||
},
|
||||
"enableBranchAutoBuild":{
|
||||
"shape":"EnableBranchAutoBuild",
|
||||
"documentation":"<p> Enables auto-building of branches for the Amplify App. </p>"
|
||||
"documentation":"<p> Enables the auto-building of branches for the Amplify app. </p>"
|
||||
},
|
||||
"enableBranchAutoDeletion":{
|
||||
"shape":"EnableBranchAutoDeletion",
|
||||
"documentation":"<p> Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository. </p>"
|
||||
},
|
||||
"enableBasicAuth":{
|
||||
"shape":"EnableBasicAuth",
|
||||
"documentation":"<p> Enables Basic Authorization for branches for the Amplify App. </p>"
|
||||
"documentation":"<p> Enables basic authorization for the Amplify app's branches. </p>"
|
||||
},
|
||||
"basicAuthCredentials":{
|
||||
"shape":"BasicAuthCredentials",
|
||||
"documentation":"<p> Basic Authorization credentials for branches for the Amplify App. </p>"
|
||||
"documentation":"<p> The basic authorization credentials for branches for the Amplify app. </p>"
|
||||
},
|
||||
"customRules":{
|
||||
"shape":"CustomRules",
|
||||
"documentation":"<p> Custom redirect / rewrite rules for the Amplify App. </p>"
|
||||
"documentation":"<p> Describes the custom redirect and rewrite rules for the Amplify app. </p>"
|
||||
},
|
||||
"productionBranch":{
|
||||
"shape":"ProductionBranch",
|
||||
"documentation":"<p> Structure with Production Branch information. </p>"
|
||||
"documentation":"<p> Describes the information about a production branch of the Amplify app. </p>"
|
||||
},
|
||||
"buildSpec":{
|
||||
"shape":"BuildSpec",
|
||||
"documentation":"<p> BuildSpec content for Amplify App. </p>"
|
||||
"documentation":"<p> Describes the content of the build specification (build spec) for the Amplify app. </p>"
|
||||
},
|
||||
"enableAutoBranchCreation":{
|
||||
"shape":"EnableAutoBranchCreation",
|
||||
"documentation":"<p> Enables automated branch creation for the Amplify App. </p>"
|
||||
"documentation":"<p> Enables automated branch creation for the Amplify app. </p>"
|
||||
},
|
||||
"autoBranchCreationPatterns":{
|
||||
"shape":"AutoBranchCreationPatterns",
|
||||
"documentation":"<p> Automated branch creation glob patterns for the Amplify App. </p>"
|
||||
"documentation":"<p> Describes the automated branch creation glob patterns for the Amplify app. </p>"
|
||||
},
|
||||
"autoBranchCreationConfig":{
|
||||
"shape":"AutoBranchCreationConfig",
|
||||
"documentation":"<p> Automated branch creation config for the Amplify App. </p>"
|
||||
"documentation":"<p> Describes the automated branch creation configuration for the Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Amplify App represents different branches of a repository for building, deploying, and hosting. </p>"
|
||||
"documentation":"<p> Represents the different branches of a repository for building, deploying, and hosting an Amplify app. </p>"
|
||||
},
|
||||
"AppArn":{
|
||||
"type":"string",
|
||||
|
|
@ -758,14 +763,14 @@
|
|||
"members":{
|
||||
"artifactFileName":{
|
||||
"shape":"ArtifactFileName",
|
||||
"documentation":"<p> File name for the artifact. </p>"
|
||||
"documentation":"<p> The file name for the artifact. </p>"
|
||||
},
|
||||
"artifactId":{
|
||||
"shape":"ArtifactId",
|
||||
"documentation":"<p> Unique Id for a artifact. </p>"
|
||||
"documentation":"<p> The unique ID for the artifact. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure for artifact. </p>"
|
||||
"documentation":"<p> Describes an artifact. </p>"
|
||||
},
|
||||
"ArtifactFileName":{
|
||||
"type":"string",
|
||||
|
|
@ -801,42 +806,42 @@
|
|||
"members":{
|
||||
"stage":{
|
||||
"shape":"Stage",
|
||||
"documentation":"<p> Stage for the auto created branch. </p>"
|
||||
"documentation":"<p> Describes the current stage for the autocreated branch. </p>"
|
||||
},
|
||||
"framework":{
|
||||
"shape":"Framework",
|
||||
"documentation":"<p> Framework for the auto created branch. </p>"
|
||||
"documentation":"<p> The framework for the autocreated branch. </p>"
|
||||
},
|
||||
"enableAutoBuild":{
|
||||
"shape":"EnableAutoBuild",
|
||||
"documentation":"<p> Enables auto building for the auto created branch. </p>"
|
||||
"documentation":"<p> Enables auto building for the autocreated branch. </p>"
|
||||
},
|
||||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p> Environment Variables for the auto created branch. </p>"
|
||||
"documentation":"<p> The environment variables for the autocreated branch. </p>"
|
||||
},
|
||||
"basicAuthCredentials":{
|
||||
"shape":"BasicAuthCredentials",
|
||||
"documentation":"<p> Basic Authorization credentials for the auto created branch. </p>"
|
||||
"documentation":"<p> The basic authorization credentials for the autocreated branch. </p>"
|
||||
},
|
||||
"enableBasicAuth":{
|
||||
"shape":"EnableBasicAuth",
|
||||
"documentation":"<p> Enables Basic Auth for the auto created branch. </p>"
|
||||
"documentation":"<p> Enables basic authorization for the autocreated branch. </p>"
|
||||
},
|
||||
"buildSpec":{
|
||||
"shape":"BuildSpec",
|
||||
"documentation":"<p> BuildSpec for the auto created branch. </p>"
|
||||
"documentation":"<p> The build specification (build spec) for the autocreated branch. </p>"
|
||||
},
|
||||
"enablePullRequestPreview":{
|
||||
"shape":"EnablePullRequestPreview",
|
||||
"documentation":"<p> Enables Pull Request Preview for auto created branch. </p>"
|
||||
"documentation":"<p> Enables pull request preview for the autocreated branch. </p>"
|
||||
},
|
||||
"pullRequestEnvironmentName":{
|
||||
"shape":"PullRequestEnvironmentName",
|
||||
"documentation":"<p> The Amplify Environment name for the pull request. </p>"
|
||||
"documentation":"<p> The Amplify environment name for the pull request. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure with auto branch creation config. </p>"
|
||||
"documentation":"<p> Describes the automated branch creation configuration. </p>"
|
||||
},
|
||||
"AutoBranchCreationPattern":{
|
||||
"type":"string",
|
||||
|
|
@ -847,6 +852,20 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"AutoBranchCreationPattern"}
|
||||
},
|
||||
"AutoSubDomainCreationPattern":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":1
|
||||
},
|
||||
"AutoSubDomainCreationPatterns":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AutoSubDomainCreationPattern"}
|
||||
},
|
||||
"AutoSubDomainIAMRole":{
|
||||
"type":"string",
|
||||
"max":1000,
|
||||
"pattern":"^$|^arn:aws:iam::\\d{12}:role.+"
|
||||
},
|
||||
"BackendEnvironment":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -858,30 +877,30 @@
|
|||
"members":{
|
||||
"backendEnvironmentArn":{
|
||||
"shape":"BackendEnvironmentArn",
|
||||
"documentation":"<p> Arn for a backend environment, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
|
||||
},
|
||||
"environmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> Name for a backend environment, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The name for a backend environment that is part of an Amplify app. </p>"
|
||||
},
|
||||
"stackName":{
|
||||
"shape":"StackName",
|
||||
"documentation":"<p> CloudFormation stack name of backend environment. </p>"
|
||||
"documentation":"<p> The AWS CloudFormation stack name of a backend environment. </p>"
|
||||
},
|
||||
"deploymentArtifacts":{
|
||||
"shape":"DeploymentArtifacts",
|
||||
"documentation":"<p> Name of deployment artifacts. </p>"
|
||||
"documentation":"<p> The name of deployment artifacts. </p>"
|
||||
},
|
||||
"createTime":{
|
||||
"shape":"CreateTime",
|
||||
"documentation":"<p> Creation date and time for a backend environment, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The creation date and time for a backend environment that is part of an Amplify app. </p>"
|
||||
},
|
||||
"updateTime":{
|
||||
"shape":"UpdateTime",
|
||||
"documentation":"<p> Last updated date and time for a backend environment, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The last updated date and time for a backend environment that is part of an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Backend environment for an Amplify App. </p>"
|
||||
"documentation":"<p> Describes the backend environment for an Amplify app. </p>"
|
||||
},
|
||||
"BackendEnvironmentArn":{
|
||||
"type":"string",
|
||||
|
|
@ -897,13 +916,14 @@
|
|||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Exception thrown when a request contains unexpected data. </p>",
|
||||
"documentation":"<p> A request contains unexpected data. </p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"BasicAuthCredentials":{
|
||||
"type":"string",
|
||||
"max":2000
|
||||
"max":2000,
|
||||
"sensitive":true
|
||||
},
|
||||
"Branch":{
|
||||
"type":"structure",
|
||||
|
|
@ -929,95 +949,95 @@
|
|||
"members":{
|
||||
"branchArn":{
|
||||
"shape":"BranchArn",
|
||||
"documentation":"<p> ARN for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The name for the branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The description for the branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p> Tag for branch for Amplify App. </p>"
|
||||
"documentation":"<p> The tag for the branch of an Amplify app. </p>"
|
||||
},
|
||||
"stage":{
|
||||
"shape":"Stage",
|
||||
"documentation":"<p> Stage for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The current stage for the branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"DisplayName",
|
||||
"documentation":"<p> Display name for a branch, will use as the default domain prefix. </p>"
|
||||
"documentation":"<p> The display name for the branch. This is used as the default domain prefix. </p>"
|
||||
},
|
||||
"enableNotification":{
|
||||
"shape":"EnableNotification",
|
||||
"documentation":"<p> Enables notifications for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> Enables notifications for a branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"createTime":{
|
||||
"shape":"CreateTime",
|
||||
"documentation":"<p> Creation date and time for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The creation date and time for a branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"updateTime":{
|
||||
"shape":"UpdateTime",
|
||||
"documentation":"<p> Last updated date and time for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The last updated date and time for a branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p> Environment Variables specific to a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The environment variables specific to a branch of an Amplify app. </p>"
|
||||
},
|
||||
"enableAutoBuild":{
|
||||
"shape":"EnableAutoBuild",
|
||||
"documentation":"<p> Enables auto-building on push for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> Enables auto-building on push for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"customDomains":{
|
||||
"shape":"CustomDomains",
|
||||
"documentation":"<p> Custom domains for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The custom domains for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"framework":{
|
||||
"shape":"Framework",
|
||||
"documentation":"<p> Framework for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The framework for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"activeJobId":{
|
||||
"shape":"ActiveJobId",
|
||||
"documentation":"<p> Id of the active job for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The ID of the active job for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"totalNumberOfJobs":{
|
||||
"shape":"TotalNumberOfJobs",
|
||||
"documentation":"<p> Total number of Jobs part of an Amplify App. </p>"
|
||||
"documentation":"<p> The total number of jobs that are part of an Amplify app. </p>"
|
||||
},
|
||||
"enableBasicAuth":{
|
||||
"shape":"EnableBasicAuth",
|
||||
"documentation":"<p> Enables Basic Authorization for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> Enables basic authorization for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"thumbnailUrl":{
|
||||
"shape":"ThumbnailUrl",
|
||||
"documentation":"<p> Thumbnail URL for the branch. </p>"
|
||||
"documentation":"<p> The thumbnail URL for the branch of an Amplify app. </p>"
|
||||
},
|
||||
"basicAuthCredentials":{
|
||||
"shape":"BasicAuthCredentials",
|
||||
"documentation":"<p> Basic Authorization credentials for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The basic authorization credentials for a branch of an Amplify app. </p>"
|
||||
},
|
||||
"buildSpec":{
|
||||
"shape":"BuildSpec",
|
||||
"documentation":"<p> BuildSpec content for branch for Amplify App. </p>"
|
||||
"documentation":"<p> The build specification (build spec) content for the branch of an Amplify app. </p>"
|
||||
},
|
||||
"ttl":{
|
||||
"shape":"TTL",
|
||||
"documentation":"<p> The content TTL for the website in seconds. </p>"
|
||||
"documentation":"<p> The content Time to Live (TTL) for the website in seconds. </p>"
|
||||
},
|
||||
"associatedResources":{
|
||||
"shape":"AssociatedResources",
|
||||
"documentation":"<p> List of custom resources that are linked to this branch. </p>"
|
||||
"documentation":"<p> A list of custom resources that are linked to this branch. </p>"
|
||||
},
|
||||
"enablePullRequestPreview":{
|
||||
"shape":"EnablePullRequestPreview",
|
||||
"documentation":"<p> Enables Pull Request Preview for this branch. </p>"
|
||||
"documentation":"<p> Enables pull request preview for the branch. </p>"
|
||||
},
|
||||
"pullRequestEnvironmentName":{
|
||||
"shape":"PullRequestEnvironmentName",
|
||||
"documentation":"<p> The Amplify Environment name for the pull request. </p>"
|
||||
"documentation":"<p> The Amplify environment name for the pull request. </p>"
|
||||
},
|
||||
"destinationBranch":{
|
||||
"shape":"BranchName",
|
||||
|
|
@ -1029,10 +1049,10 @@
|
|||
},
|
||||
"backendEnvironmentArn":{
|
||||
"shape":"BackendEnvironmentArn",
|
||||
"documentation":"<p> ARN for a Backend Environment, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Branch for an Amplify App, which maps to a 3rd party repository branch. </p>"
|
||||
"documentation":"<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>"
|
||||
},
|
||||
"BranchArn":{
|
||||
"type":"string",
|
||||
|
|
@ -1050,7 +1070,7 @@
|
|||
},
|
||||
"BuildSpec":{
|
||||
"type":"string",
|
||||
"documentation":"<p> BuildSpec file for Amplify app build. </p>",
|
||||
"documentation":"<p> The build specification (build spec) file for an Amplify app build. </p>",
|
||||
"max":25000,
|
||||
"min":1
|
||||
},
|
||||
|
|
@ -1080,74 +1100,78 @@
|
|||
"members":{
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p> Name for the Amplify App </p>"
|
||||
"documentation":"<p> The name for the Amplify app. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for an Amplify App </p>"
|
||||
"documentation":"<p> The description for an Amplify app. </p>"
|
||||
},
|
||||
"repository":{
|
||||
"shape":"Repository",
|
||||
"documentation":"<p> Repository for an Amplify App </p>"
|
||||
"documentation":"<p> The repository for an Amplify app. </p>"
|
||||
},
|
||||
"platform":{
|
||||
"shape":"Platform",
|
||||
"documentation":"<p> Platform / framework for an Amplify App </p>"
|
||||
"documentation":"<p> The platform or framework for an Amplify app. </p>"
|
||||
},
|
||||
"iamServiceRoleArn":{
|
||||
"shape":"ServiceRoleArn",
|
||||
"documentation":"<p> AWS IAM service role for an Amplify App </p>"
|
||||
"documentation":"<p> The AWS Identity and Access Management (IAM) service role 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>"
|
||||
"documentation":"<p> The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The 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> The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored. </p>"
|
||||
},
|
||||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p> Environment variables map for an Amplify App. </p>"
|
||||
"documentation":"<p> The environment variables map for an Amplify app. </p>"
|
||||
},
|
||||
"enableBranchAutoBuild":{
|
||||
"shape":"EnableBranchAutoBuild",
|
||||
"documentation":"<p> Enable the auto building of branches for an Amplify App. </p>"
|
||||
"documentation":"<p> Enables the auto building of branches for an Amplify app. </p>"
|
||||
},
|
||||
"enableBranchAutoDeletion":{
|
||||
"shape":"EnableBranchAutoDeletion",
|
||||
"documentation":"<p> Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. </p>"
|
||||
},
|
||||
"enableBasicAuth":{
|
||||
"shape":"EnableBasicAuth",
|
||||
"documentation":"<p> Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App. </p>"
|
||||
"documentation":"<p> Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app. </p>"
|
||||
},
|
||||
"basicAuthCredentials":{
|
||||
"shape":"BasicAuthCredentials",
|
||||
"documentation":"<p> Credentials for Basic Authorization for an Amplify App. </p>"
|
||||
"documentation":"<p> The credentials for basic authorization for an Amplify app. </p>"
|
||||
},
|
||||
"customRules":{
|
||||
"shape":"CustomRules",
|
||||
"documentation":"<p> Custom rewrite / redirect rules for an Amplify App. </p>"
|
||||
"documentation":"<p> The custom rewrite and redirect rules for an Amplify app. </p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p> Tag for an Amplify App </p>"
|
||||
"documentation":"<p> The tag for an Amplify app. </p>"
|
||||
},
|
||||
"buildSpec":{
|
||||
"shape":"BuildSpec",
|
||||
"documentation":"<p> BuildSpec for an Amplify App </p>"
|
||||
"documentation":"<p> The build specification (build spec) for an Amplify app. </p>"
|
||||
},
|
||||
"enableAutoBranchCreation":{
|
||||
"shape":"EnableAutoBranchCreation",
|
||||
"documentation":"<p> Enables automated branch creation for the Amplify App. </p>"
|
||||
"documentation":"<p> Enables automated branch creation for the Amplify app. </p>"
|
||||
},
|
||||
"autoBranchCreationPatterns":{
|
||||
"shape":"AutoBranchCreationPatterns",
|
||||
"documentation":"<p> Automated branch creation glob patterns for the Amplify App. </p>"
|
||||
"documentation":"<p> The automated branch creation glob patterns for the Amplify app. </p>"
|
||||
},
|
||||
"autoBranchCreationConfig":{
|
||||
"shape":"AutoBranchCreationConfig",
|
||||
"documentation":"<p> Automated branch creation config for the Amplify App. </p>"
|
||||
"documentation":"<p> The automated branch creation configuration for the Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure used to create Apps in Amplify. </p>"
|
||||
"documentation":"<p> The request structure used to create apps in Amplify. </p>"
|
||||
},
|
||||
"CreateAppResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1165,24 +1189,24 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"environmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> Name for the backend environment. </p>"
|
||||
"documentation":"<p> The name for the backend environment. </p>"
|
||||
},
|
||||
"stackName":{
|
||||
"shape":"StackName",
|
||||
"documentation":"<p> CloudFormation stack name of backend environment. </p>"
|
||||
"documentation":"<p> The AWS CloudFormation stack name of a backend environment. </p>"
|
||||
},
|
||||
"deploymentArtifacts":{
|
||||
"shape":"DeploymentArtifacts",
|
||||
"documentation":"<p> Name of deployment artifacts. </p>"
|
||||
"documentation":"<p> The name of deployment artifacts. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for a backend environment create request. </p>"
|
||||
"documentation":"<p> The request structure for the backend environment create request. </p>"
|
||||
},
|
||||
"CreateBackendEnvironmentResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1190,10 +1214,10 @@
|
|||
"members":{
|
||||
"backendEnvironment":{
|
||||
"shape":"BackendEnvironment",
|
||||
"documentation":"<p> Backend environment structure for an amplify App. </p>"
|
||||
"documentation":"<p> Describes the backend environment for an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for create backend environment. </p>"
|
||||
"documentation":"<p> The result structure for the create backend environment request. </p>"
|
||||
},
|
||||
"CreateBranchRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1204,25 +1228,25 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch. </p>"
|
||||
"documentation":"<p> The name for the branch. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for the branch. </p>"
|
||||
"documentation":"<p> The description for the branch. </p>"
|
||||
},
|
||||
"stage":{
|
||||
"shape":"Stage",
|
||||
"documentation":"<p> Stage for the branch. </p>"
|
||||
"documentation":"<p> Describes the current stage for the branch. </p>"
|
||||
},
|
||||
"framework":{
|
||||
"shape":"Framework",
|
||||
"documentation":"<p> Framework for the branch. </p>"
|
||||
"documentation":"<p> The framework for the branch. </p>"
|
||||
},
|
||||
"enableNotification":{
|
||||
"shape":"EnableNotification",
|
||||
|
|
@ -1234,46 +1258,46 @@
|
|||
},
|
||||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p> Environment Variables for the branch. </p>"
|
||||
"documentation":"<p> The environment variables for the branch. </p>"
|
||||
},
|
||||
"basicAuthCredentials":{
|
||||
"shape":"BasicAuthCredentials",
|
||||
"documentation":"<p> Basic Authorization credentials for the branch. </p>"
|
||||
"documentation":"<p> The basic authorization credentials for the branch. </p>"
|
||||
},
|
||||
"enableBasicAuth":{
|
||||
"shape":"EnableBasicAuth",
|
||||
"documentation":"<p> Enables Basic Auth for the branch. </p>"
|
||||
"documentation":"<p> Enables basic authorization for the branch. </p>"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p> Tag for the branch. </p>"
|
||||
"documentation":"<p> The tag for the branch. </p>"
|
||||
},
|
||||
"buildSpec":{
|
||||
"shape":"BuildSpec",
|
||||
"documentation":"<p> BuildSpec for the branch. </p>"
|
||||
"documentation":"<p> The build specification (build spec) for the branch. </p>"
|
||||
},
|
||||
"ttl":{
|
||||
"shape":"TTL",
|
||||
"documentation":"<p> The content TTL for the website in seconds. </p>"
|
||||
"documentation":"<p> The content Time To Live (TTL) for the website in seconds. </p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"DisplayName",
|
||||
"documentation":"<p> Display name for a branch, will use as the default domain prefix. </p>"
|
||||
"documentation":"<p> The display name for a branch. This is used as the default domain prefix. </p>"
|
||||
},
|
||||
"enablePullRequestPreview":{
|
||||
"shape":"EnablePullRequestPreview",
|
||||
"documentation":"<p> Enables Pull Request Preview for this branch. </p>"
|
||||
"documentation":"<p> Enables pull request preview for this branch. </p>"
|
||||
},
|
||||
"pullRequestEnvironmentName":{
|
||||
"shape":"PullRequestEnvironmentName",
|
||||
"documentation":"<p> The Amplify Environment name for the pull request. </p>"
|
||||
"documentation":"<p> The Amplify environment name for the pull request. </p>"
|
||||
},
|
||||
"backendEnvironmentArn":{
|
||||
"shape":"BackendEnvironmentArn",
|
||||
"documentation":"<p> ARN for a Backend Environment, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for a branch create request. </p>"
|
||||
"documentation":"<p> The request structure for the create branch request. </p>"
|
||||
},
|
||||
"CreateBranchResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1281,10 +1305,10 @@
|
|||
"members":{
|
||||
"branch":{
|
||||
"shape":"Branch",
|
||||
"documentation":"<p> Branch structure for an Amplify App. </p>"
|
||||
"documentation":"<p> Describes the branch for an Amplify app, which maps to a third-party repository branch. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for create branch request. </p>"
|
||||
"documentation":"<p> The result structure for create branch request. </p>"
|
||||
},
|
||||
"CreateDeploymentRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1295,22 +1319,22 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch, for the Job. </p>",
|
||||
"documentation":"<p> The name for the branch, for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"fileMap":{
|
||||
"shape":"FileMap",
|
||||
"documentation":"<p> Optional file map that contains file name as the key and file content md5 hash as the value. If this argument is provided, the service will generate different upload url per file. Otherwise, the service will only generate a single upload url for the zipped files. </p>"
|
||||
"documentation":"<p> An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for create a new deployment. </p>"
|
||||
"documentation":"<p> The request structure for the create a new deployment request. </p>"
|
||||
},
|
||||
"CreateDeploymentResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1321,18 +1345,18 @@
|
|||
"members":{
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> The jobId for this deployment, will supply to start deployment api. </p>"
|
||||
"documentation":"<p> The job ID for this deployment. will supply to start deployment api. </p>"
|
||||
},
|
||||
"fileUploadUrls":{
|
||||
"shape":"FileUploadUrls",
|
||||
"documentation":"<p> When the fileMap argument is provided in the request, the fileUploadUrls will contain a map of file names to upload url. </p>"
|
||||
"documentation":"<p> When the <code>fileMap</code> argument is provided in the request, <code>fileUploadUrls</code> will contain a map of file names to upload URLs. </p>"
|
||||
},
|
||||
"zipUploadUrl":{
|
||||
"shape":"UploadUrl",
|
||||
"documentation":"<p> When the fileMap argument is NOT provided. This zipUploadUrl will be returned. </p>"
|
||||
"documentation":"<p> When the <code>fileMap</code> argument is not provided in the request, this <code>zipUploadUrl</code> is returned. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for create a new deployment. </p>"
|
||||
"documentation":"<p> The result structure for the create a new deployment request. </p>"
|
||||
},
|
||||
"CreateDomainAssociationRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1344,24 +1368,32 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"domainName":{
|
||||
"shape":"DomainName",
|
||||
"documentation":"<p> Domain name for the Domain Association. </p>"
|
||||
"documentation":"<p> The domain name for the domain association. </p>"
|
||||
},
|
||||
"enableAutoSubDomain":{
|
||||
"shape":"EnableAutoSubDomain",
|
||||
"documentation":"<p> Enables automated creation of Subdomains for branches. (Currently not supported) </p>"
|
||||
"documentation":"<p> Enables the automated creation of subdomains for branches. </p>"
|
||||
},
|
||||
"subDomainSettings":{
|
||||
"shape":"SubDomainSettings",
|
||||
"documentation":"<p> Setting structure for the Subdomain. </p>"
|
||||
"documentation":"<p> The setting for the subdomain. </p>"
|
||||
},
|
||||
"autoSubDomainCreationPatterns":{
|
||||
"shape":"AutoSubDomainCreationPatterns",
|
||||
"documentation":"<p> Sets the branch patterns for automatic subdomain creation. </p>"
|
||||
},
|
||||
"autoSubDomainIAMRole":{
|
||||
"shape":"AutoSubDomainIAMRole",
|
||||
"documentation":"<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for create Domain Association request. </p>"
|
||||
"documentation":"<p> The request structure for the create domain association request. </p>"
|
||||
},
|
||||
"CreateDomainAssociationResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1369,10 +1401,10 @@
|
|||
"members":{
|
||||
"domainAssociation":{
|
||||
"shape":"DomainAssociation",
|
||||
"documentation":"<p> Domain Association structure. </p>"
|
||||
"documentation":"<p> Describes the structure of a domain association, which associates a custom domain with an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the create Domain Association request. </p>"
|
||||
"documentation":"<p> The result structure for the create domain association request. </p>"
|
||||
},
|
||||
"CreateTime":{"type":"timestamp"},
|
||||
"CreateWebhookRequest":{
|
||||
|
|
@ -1384,20 +1416,20 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The 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>"
|
||||
"documentation":"<p> The name for a branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for a webhook. </p>"
|
||||
"documentation":"<p> The description for a webhook. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for create webhook request. </p>"
|
||||
"documentation":"<p> The request structure for the create webhook request. </p>"
|
||||
},
|
||||
"CreateWebhookResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1405,10 +1437,10 @@
|
|||
"members":{
|
||||
"webhook":{
|
||||
"shape":"Webhook",
|
||||
"documentation":"<p> Webhook structure. </p>"
|
||||
"documentation":"<p> Describes a webhook that connects repository events to an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the create webhook request. </p>"
|
||||
"documentation":"<p> The result structure for the create webhook request. </p>"
|
||||
},
|
||||
"CustomDomain":{
|
||||
"type":"string",
|
||||
|
|
@ -1440,10 +1472,10 @@
|
|||
},
|
||||
"condition":{
|
||||
"shape":"Condition",
|
||||
"documentation":"<p> The condition for a URL rewrite or redirect rule, e.g. country code. </p>"
|
||||
"documentation":"<p> The condition for a URL rewrite or redirect rule, such as a country code. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Custom rewrite / redirect rule. </p>"
|
||||
"documentation":"<p> Describes a custom rewrite or redirect rule. </p>"
|
||||
},
|
||||
"CustomRules":{
|
||||
"type":"list",
|
||||
|
|
@ -1464,12 +1496,12 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for an Amplify App delete request. </p>"
|
||||
"documentation":"<p> Describes the request structure for the delete app request. </p>"
|
||||
},
|
||||
"DeleteAppResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1477,7 +1509,7 @@
|
|||
"members":{
|
||||
"app":{"shape":"App"}
|
||||
},
|
||||
"documentation":"<p> Result structure for an Amplify App delete request. </p>"
|
||||
"documentation":"<p> The result structure for the delete app request. </p>"
|
||||
},
|
||||
"DeleteBackendEnvironmentRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1488,18 +1520,18 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id of an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID of an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"environmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> Name of a backend environment of an Amplify App. </p>",
|
||||
"documentation":"<p> The name of a backend environment of an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"environmentName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for delete backend environment request. </p>"
|
||||
"documentation":"<p> The request structure for the delete backend environment request. </p>"
|
||||
},
|
||||
"DeleteBackendEnvironmentResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1507,10 +1539,10 @@
|
|||
"members":{
|
||||
"backendEnvironment":{
|
||||
"shape":"BackendEnvironment",
|
||||
"documentation":"<p> Backend environment structure for an Amplify App. </p>"
|
||||
"documentation":"<p> Describes the backend environment for an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure of a delete backend environment result. </p>"
|
||||
"documentation":"<p> The result structure of the delete backend environment result. </p>"
|
||||
},
|
||||
"DeleteBranchRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1521,18 +1553,18 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch. </p>",
|
||||
"documentation":"<p> The name for the branch. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for delete branch request. </p>"
|
||||
"documentation":"<p> The request structure for the delete branch request. </p>"
|
||||
},
|
||||
"DeleteBranchResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1540,10 +1572,10 @@
|
|||
"members":{
|
||||
"branch":{
|
||||
"shape":"Branch",
|
||||
"documentation":"<p> Branch structure for an Amplify App. </p>"
|
||||
"documentation":"<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for delete branch request. </p>"
|
||||
"documentation":"<p> The result structure for the delete branch request. </p>"
|
||||
},
|
||||
"DeleteDomainAssociationRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1554,18 +1586,18 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique id for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"domainName":{
|
||||
"shape":"DomainName",
|
||||
"documentation":"<p> Name of the domain. </p>",
|
||||
"documentation":"<p> The name of the domain. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"domainName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the delete Domain Association request. </p>"
|
||||
"documentation":"<p> The request structure for the delete domain association request. </p>"
|
||||
},
|
||||
"DeleteDomainAssociationResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1584,24 +1616,24 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch, for the Job. </p>",
|
||||
"documentation":"<p> The name for the branch, for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> Unique Id for the Job. </p>",
|
||||
"documentation":"<p> The unique ID for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"jobId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for delete job request. </p>"
|
||||
"documentation":"<p> The request structure for the delete job request. </p>"
|
||||
},
|
||||
"DeleteJobResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1609,7 +1641,7 @@
|
|||
"members":{
|
||||
"jobSummary":{"shape":"JobSummary"}
|
||||
},
|
||||
"documentation":"<p> Result structure for the delete job request. </p>"
|
||||
"documentation":"<p> The result structure for the delete job request. </p>"
|
||||
},
|
||||
"DeleteWebhookRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1617,12 +1649,12 @@
|
|||
"members":{
|
||||
"webhookId":{
|
||||
"shape":"WebhookId",
|
||||
"documentation":"<p> Unique Id for a webhook. </p>",
|
||||
"documentation":"<p> The unique ID for a webhook. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"webhookId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the delete webhook request. </p>"
|
||||
"documentation":"<p> The request structure for the delete webhook request. </p>"
|
||||
},
|
||||
"DeleteWebhookResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1630,17 +1662,17 @@
|
|||
"members":{
|
||||
"webhook":{
|
||||
"shape":"Webhook",
|
||||
"documentation":"<p> Webhook structure. </p>"
|
||||
"documentation":"<p> Describes a webhook that connects repository events to an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the delete webhook request. </p>"
|
||||
"documentation":"<p> The result structure for the delete webhook request. </p>"
|
||||
},
|
||||
"DependentServiceFailureException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Exception thrown when an operation fails due to a dependent service throwing an exception. </p>",
|
||||
"documentation":"<p> An operation failed because a dependent service threw an exception. </p>",
|
||||
"error":{"httpStatusCode":503},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -1670,34 +1702,42 @@
|
|||
"members":{
|
||||
"domainAssociationArn":{
|
||||
"shape":"DomainAssociationArn",
|
||||
"documentation":"<p> ARN for the Domain Association. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for the domain association. </p>"
|
||||
},
|
||||
"domainName":{
|
||||
"shape":"DomainName",
|
||||
"documentation":"<p> Name of the domain. </p>"
|
||||
"documentation":"<p> The name of the domain. </p>"
|
||||
},
|
||||
"enableAutoSubDomain":{
|
||||
"shape":"EnableAutoSubDomain",
|
||||
"documentation":"<p> Enables automated creation of Subdomains for branches. (Currently not supported) </p>"
|
||||
"documentation":"<p> Enables the automated creation of subdomains for branches. </p>"
|
||||
},
|
||||
"autoSubDomainCreationPatterns":{
|
||||
"shape":"AutoSubDomainCreationPatterns",
|
||||
"documentation":"<p> Sets branch patterns for automatic subdomain creation. </p>"
|
||||
},
|
||||
"autoSubDomainIAMRole":{
|
||||
"shape":"AutoSubDomainIAMRole",
|
||||
"documentation":"<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>"
|
||||
},
|
||||
"domainStatus":{
|
||||
"shape":"DomainStatus",
|
||||
"documentation":"<p> Status fo the Domain Association. </p>"
|
||||
"documentation":"<p> The current status of the domain association. </p>"
|
||||
},
|
||||
"statusReason":{
|
||||
"shape":"StatusReason",
|
||||
"documentation":"<p> Reason for the current status of the Domain Association. </p>"
|
||||
"documentation":"<p> The reason for the current status of the domain association. </p>"
|
||||
},
|
||||
"certificateVerificationDNSRecord":{
|
||||
"shape":"CertificateVerificationDNSRecord",
|
||||
"documentation":"<p> DNS Record for certificate verification. </p>"
|
||||
"documentation":"<p> The DNS record for certificate verification. </p>"
|
||||
},
|
||||
"subDomains":{
|
||||
"shape":"SubDomains",
|
||||
"documentation":"<p> Subdomains for the Domain Association. </p>"
|
||||
"documentation":"<p> The subdomains for the domain association. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure for Domain Association, which associates a custom domain with an Amplify App. </p>"
|
||||
"documentation":"<p> Describes a domain association that associates a custom domain with an Amplify app. </p>"
|
||||
},
|
||||
"DomainAssociationArn":{
|
||||
"type":"string",
|
||||
|
|
@ -1734,6 +1774,7 @@
|
|||
"EnableAutoSubDomain":{"type":"boolean"},
|
||||
"EnableBasicAuth":{"type":"boolean"},
|
||||
"EnableBranchAutoBuild":{"type":"boolean"},
|
||||
"EnableBranchAutoDeletion":{"type":"boolean"},
|
||||
"EnableNotification":{"type":"boolean"},
|
||||
"EnablePullRequestPreview":{"type":"boolean"},
|
||||
"EndTime":{"type":"timestamp"},
|
||||
|
|
@ -1786,34 +1827,34 @@
|
|||
"members":{
|
||||
"startTime":{
|
||||
"shape":"StartTime",
|
||||
"documentation":"<p> The time at which the logs should start, inclusive. </p>"
|
||||
"documentation":"<p> The time at which the logs should start. The time range specified is inclusive of the start time. </p>"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"EndTime",
|
||||
"documentation":"<p> The time at which the logs should end, inclusive. </p>"
|
||||
"documentation":"<p> The time at which the logs should end. The time range specified is inclusive of the end time. </p>"
|
||||
},
|
||||
"domainName":{
|
||||
"shape":"DomainName",
|
||||
"documentation":"<p> Name of the domain. </p>"
|
||||
"documentation":"<p> The name of the domain. </p>"
|
||||
},
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the generate access logs request. </p>"
|
||||
"documentation":"<p> The 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> The pre-signed URL for the requested access logs. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the generate access logs request. </p>"
|
||||
"documentation":"<p> The result structure for the generate access logs request. </p>"
|
||||
},
|
||||
"GetAppRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1821,12 +1862,12 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for get App request. </p>"
|
||||
"documentation":"<p> The request structure for the get app request. </p>"
|
||||
},
|
||||
"GetAppResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1841,12 +1882,12 @@
|
|||
"members":{
|
||||
"artifactId":{
|
||||
"shape":"ArtifactId",
|
||||
"documentation":"<p> Unique Id for a artifact. </p>",
|
||||
"documentation":"<p> The unique ID for an artifact. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"artifactId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the get artifact request. </p>"
|
||||
"documentation":"<p> Returns the request structure for the get artifact request. </p>"
|
||||
},
|
||||
"GetArtifactUrlResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1857,14 +1898,14 @@
|
|||
"members":{
|
||||
"artifactId":{
|
||||
"shape":"ArtifactId",
|
||||
"documentation":"<p> Unique Id for a artifact. </p>"
|
||||
"documentation":"<p> The unique ID for an artifact. </p>"
|
||||
},
|
||||
"artifactUrl":{
|
||||
"shape":"ArtifactUrl",
|
||||
"documentation":"<p> Presigned url for the artifact. </p>"
|
||||
"documentation":"<p> The presigned URL for the artifact. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the get artifact request. </p>"
|
||||
"documentation":"<p> Returns the result structure for the get artifact request. </p>"
|
||||
},
|
||||
"GetBackendEnvironmentRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1875,18 +1916,18 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique id for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"environmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> Name for the backend environment. </p>",
|
||||
"documentation":"<p> The name for the backend environment. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"environmentName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for get backend environment request. </p>"
|
||||
"documentation":"<p> The request structure for the get backend environment request. </p>"
|
||||
},
|
||||
"GetBackendEnvironmentResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1894,10 +1935,10 @@
|
|||
"members":{
|
||||
"backendEnvironment":{
|
||||
"shape":"BackendEnvironment",
|
||||
"documentation":"<p> Backend environment structure for an an Amplify App. </p>"
|
||||
"documentation":"<p> Describes the backend environment for an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for get backend environment result. </p>"
|
||||
"documentation":"<p> The result structure for the get backend environment result. </p>"
|
||||
},
|
||||
"GetBranchRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1908,18 +1949,18 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch. </p>",
|
||||
"documentation":"<p> The name for the branch. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for get branch request. </p>"
|
||||
"documentation":"<p> The request structure for the get branch request. </p>"
|
||||
},
|
||||
"GetBranchResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1937,18 +1978,18 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique id for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"domainName":{
|
||||
"shape":"DomainName",
|
||||
"documentation":"<p> Name of the domain. </p>",
|
||||
"documentation":"<p> The name of the domain. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"domainName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the get Domain Association request. </p>"
|
||||
"documentation":"<p> The request structure for the get domain association request. </p>"
|
||||
},
|
||||
"GetDomainAssociationResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1956,10 +1997,10 @@
|
|||
"members":{
|
||||
"domainAssociation":{
|
||||
"shape":"DomainAssociation",
|
||||
"documentation":"<p> Domain Association structure. </p>"
|
||||
"documentation":"<p> Describes the structure of a domain association, which associates a custom domain with an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the get Domain Association request. </p>"
|
||||
"documentation":"<p> The result structure for the get domain association request. </p>"
|
||||
},
|
||||
"GetJobRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1971,24 +2012,24 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch, for the Job. </p>",
|
||||
"documentation":"<p> The branch name for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> Unique Id for the Job. </p>",
|
||||
"documentation":"<p> The unique ID for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"jobId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for get job request. </p>"
|
||||
"documentation":"<p> The request structure for the get job request. </p>"
|
||||
},
|
||||
"GetJobResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2003,12 +2044,12 @@
|
|||
"members":{
|
||||
"webhookId":{
|
||||
"shape":"WebhookId",
|
||||
"documentation":"<p> Unique Id for a webhook. </p>",
|
||||
"documentation":"<p> The unique ID for a webhook. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"webhookId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the get webhook request. </p>"
|
||||
"documentation":"<p> The request structure for the get webhook request. </p>"
|
||||
},
|
||||
"GetWebhookResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2016,17 +2057,17 @@
|
|||
"members":{
|
||||
"webhook":{
|
||||
"shape":"Webhook",
|
||||
"documentation":"<p> Webhook structure. </p>"
|
||||
"documentation":"<p> Describes the structure of a webhook. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the get webhook request. </p>"
|
||||
"documentation":"<p> The result structure for the get webhook request. </p>"
|
||||
},
|
||||
"InternalFailureException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Exception thrown when the service fails to perform an operation due to an internal issue. </p>",
|
||||
"documentation":"<p> The service failed to perform an operation due to an internal issue. </p>",
|
||||
"error":{"httpStatusCode":500},
|
||||
"exception":true,
|
||||
"fault":true
|
||||
|
|
@ -2040,14 +2081,14 @@
|
|||
"members":{
|
||||
"summary":{
|
||||
"shape":"JobSummary",
|
||||
"documentation":"<p> Summary for an execution job for an Amplify App. </p>"
|
||||
"documentation":"<p> Describes the summary for an execution job for an Amplify app. </p>"
|
||||
},
|
||||
"steps":{
|
||||
"shape":"Steps",
|
||||
"documentation":"<p> Execution steps for an execution job, for an Amplify App. </p>"
|
||||
"documentation":"<p> The execution steps for an execution job, for an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure for an execution job for an Amplify App. </p>"
|
||||
"documentation":"<p> Describes an execution job for an Amplify app. </p>"
|
||||
},
|
||||
"JobArn":{
|
||||
"type":"string",
|
||||
|
|
@ -2092,42 +2133,42 @@
|
|||
"members":{
|
||||
"jobArn":{
|
||||
"shape":"JobArn",
|
||||
"documentation":"<p> Arn for the Job. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for the job. </p>"
|
||||
},
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> Unique Id for the Job. </p>"
|
||||
"documentation":"<p> The unique ID for the job. </p>"
|
||||
},
|
||||
"commitId":{
|
||||
"shape":"CommitId",
|
||||
"documentation":"<p> Commit Id from 3rd party repository provider for the Job. </p>"
|
||||
"documentation":"<p> The commit ID from a third-party repository provider for the job. </p>"
|
||||
},
|
||||
"commitMessage":{
|
||||
"shape":"CommitMessage",
|
||||
"documentation":"<p> Commit message from 3rd party repository provider for the Job. </p>"
|
||||
"documentation":"<p> The commit message from a third-party repository provider for the job. </p>"
|
||||
},
|
||||
"commitTime":{
|
||||
"shape":"CommitTime",
|
||||
"documentation":"<p> Commit date / time for the Job. </p>"
|
||||
"documentation":"<p> The commit date and time for the job. </p>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"StartTime",
|
||||
"documentation":"<p> Start date / time for the Job. </p>"
|
||||
"documentation":"<p> The start date and time for the job. </p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"JobStatus",
|
||||
"documentation":"<p> Status for the Job. </p>"
|
||||
"documentation":"<p> The current status for the job. </p>"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"EndTime",
|
||||
"documentation":"<p> End date / time for the Job. </p>"
|
||||
"documentation":"<p> The end date and time for the job. </p>"
|
||||
},
|
||||
"jobType":{
|
||||
"shape":"JobType",
|
||||
"documentation":"<p> Type for the Job. \\n \"RELEASE\": Manually released from source by using StartJob API. \"RETRY\": Manually retried by using StartJob API. \"WEB_HOOK\": Automatically triggered by WebHooks. </p>"
|
||||
"documentation":"<p> The type for the job. If the value is <code>RELEASE</code>, the job was manually released from its source by using the <code>StartJob</code> API. If the value is <code>RETRY</code>, the job was manually retried using the <code>StartJob</code> API. If the value is <code>WEB_HOOK</code>, the job was automatically triggered by webhooks. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure for the summary of a Job. </p>"
|
||||
"documentation":"<p> Describes the summary for an execution job for an Amplify app. </p>"
|
||||
},
|
||||
"JobType":{
|
||||
"type":"string",
|
||||
|
|
@ -2145,7 +2186,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Exception thrown when a resource could not be created because of service limits. </p>",
|
||||
"documentation":"<p> A resource could not be created because service quotas were exceeded. </p>",
|
||||
"error":{"httpStatusCode":429},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2154,18 +2195,18 @@
|
|||
"members":{
|
||||
"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> A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p> Maximum number of records to list in a single response. </p>",
|
||||
"documentation":"<p> The maximum number of records to list in a single response. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for an Amplify App list request. </p>"
|
||||
"documentation":"<p> The request structure for the list apps request. </p>"
|
||||
},
|
||||
"ListAppsResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2173,14 +2214,14 @@
|
|||
"members":{
|
||||
"apps":{
|
||||
"shape":"Apps",
|
||||
"documentation":"<p> List of Amplify Apps. </p>"
|
||||
"documentation":"<p> A list of Amplify apps. </p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p> Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects. </p>"
|
||||
"documentation":"<p> A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for an Amplify App list request. </p>"
|
||||
"documentation":"<p> The result structure for an Amplify app list request. </p>"
|
||||
},
|
||||
"ListArtifactsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2192,36 +2233,36 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The 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>",
|
||||
"documentation":"<p> The name of a branch that is part of an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> Unique Id for an Job. </p>",
|
||||
"documentation":"<p> The unique ID for a job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"jobId"
|
||||
},
|
||||
"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>",
|
||||
"documentation":"<p> A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, 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>",
|
||||
"documentation":"<p> The 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>"
|
||||
"documentation":"<p> Describes the request structure for the list artifacts request. </p>"
|
||||
},
|
||||
"ListArtifactsResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2229,14 +2270,14 @@
|
|||
"members":{
|
||||
"artifacts":{
|
||||
"shape":"Artifacts",
|
||||
"documentation":"<p> List of artifacts. </p>"
|
||||
"documentation":"<p> A 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> A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the list artifacts request. </p>"
|
||||
"documentation":"<p> The result structure for the list artifacts request. </p>"
|
||||
},
|
||||
"ListBackendEnvironmentsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2244,28 +2285,30 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"environmentName":{
|
||||
"shape":"EnvironmentName",
|
||||
"documentation":"<p> Name of the backend environment </p>"
|
||||
"documentation":"<p> The name of the backend environment </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"environmentName"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p> Pagination token. Set to null to start listing backen environments from start. If a non-null pagination token is returned in a result, then pass its value in here to list more backend environments. </p>",
|
||||
"documentation":"<p> A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p> Maximum number of records to list in a single response. </p>",
|
||||
"documentation":"<p> The maximum number of records to list in a single response. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for list backend environments request. </p>"
|
||||
"documentation":"<p> The request structure for the list backend environments request. </p>"
|
||||
},
|
||||
"ListBackendEnvironmentsResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2273,14 +2316,14 @@
|
|||
"members":{
|
||||
"backendEnvironments":{
|
||||
"shape":"BackendEnvironments",
|
||||
"documentation":"<p> List of backend environments for an Amplify App. </p>"
|
||||
"documentation":"<p> The list of backend environments for an Amplify app. </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> A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for list backend environments result. </p>"
|
||||
"documentation":"<p> The result structure for the list backend environments result. </p>"
|
||||
},
|
||||
"ListBranchesRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2288,24 +2331,24 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p> Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches. </p>",
|
||||
"documentation":"<p> A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p> Maximum number of records to list in a single response. </p>",
|
||||
"documentation":"<p> The maximum number of records to list in a single response. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for list branches request. </p>"
|
||||
"documentation":"<p> The request structure for the list branches request. </p>"
|
||||
},
|
||||
"ListBranchesResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2313,14 +2356,14 @@
|
|||
"members":{
|
||||
"branches":{
|
||||
"shape":"Branches",
|
||||
"documentation":"<p> List of branches for an Amplify App. </p>"
|
||||
"documentation":"<p> A list of branches for an Amplify app. </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> A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for list branches request. </p>"
|
||||
"documentation":"<p> The result structure for the list branches request. </p>"
|
||||
},
|
||||
"ListDomainAssociationsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2328,24 +2371,24 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p> Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects. </p>",
|
||||
"documentation":"<p> A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p> Maximum number of records to list in a single response. </p>",
|
||||
"documentation":"<p> The maximum number of records to list in a single response. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the list Domain Associations request. </p>"
|
||||
"documentation":"<p> The request structure for the list domain associations request. </p>"
|
||||
},
|
||||
"ListDomainAssociationsResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2353,14 +2396,14 @@
|
|||
"members":{
|
||||
"domainAssociations":{
|
||||
"shape":"DomainAssociations",
|
||||
"documentation":"<p> List of Domain Associations. </p>"
|
||||
"documentation":"<p> A list of domain associations. </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> A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the list Domain Association request. </p>"
|
||||
"documentation":"<p> The result structure for the list domain association request. </p>"
|
||||
},
|
||||
"ListJobsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2371,30 +2414,30 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for a branch. </p>",
|
||||
"documentation":"<p> The name for a branch. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p> Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps. </p>",
|
||||
"documentation":"<p> A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p> Maximum number of records to list in a single response. </p>",
|
||||
"documentation":"<p> The maximum number of records to list in a single response. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for list job request. </p>"
|
||||
"documentation":"<p> The request structure for the list jobs request. </p>"
|
||||
},
|
||||
"ListJobsResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2402,14 +2445,14 @@
|
|||
"members":{
|
||||
"jobSummaries":{
|
||||
"shape":"JobSummaries",
|
||||
"documentation":"<p> Result structure for list job result request. </p>"
|
||||
"documentation":"<p> The result structure for the list job result request. </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> A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Maximum number of records to list in a single response. </p>"
|
||||
"documentation":"<p> The maximum number of records to list in a single response. </p>"
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2417,22 +2460,22 @@
|
|||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"documentation":"<p> Resource arn used to list tags. </p>",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) to use to list tags. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure used to list tags for resource. </p>"
|
||||
"documentation":"<p> The request structure to use to list tags for a resource. </p>"
|
||||
},
|
||||
"ListTagsForResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p> Tags result for response. </p>"
|
||||
"documentation":"<p> A list of tags for the specified The Amazon Resource Name (ARN). </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Response for list tags. </p>"
|
||||
"documentation":"<p> The response for the list tags for resource request. </p>"
|
||||
},
|
||||
"ListWebhooksRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2440,24 +2483,24 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p> Pagination token. Set to null to start listing webhooks from start. If non-null pagination token is returned in a result, then pass its value in here to list more webhooks. </p>",
|
||||
"documentation":"<p> A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p> Maximum number of records to list in a single response. </p>",
|
||||
"documentation":"<p> The maximum number of records to list in a single response. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for the list webhooks request. </p>"
|
||||
"documentation":"<p> The request structure for the list webhooks request. </p>"
|
||||
},
|
||||
"ListWebhooksResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2465,14 +2508,14 @@
|
|||
"members":{
|
||||
"webhooks":{
|
||||
"shape":"Webhooks",
|
||||
"documentation":"<p> List of webhooks. </p>"
|
||||
"documentation":"<p> A list of webhooks. </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> A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the list webhooks request. </p>"
|
||||
"documentation":"<p> The result structure for the list webhooks request. </p>"
|
||||
},
|
||||
"LogUrl":{
|
||||
"type":"string",
|
||||
|
|
@ -2501,13 +2544,14 @@
|
|||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Exception thrown when an entity has not been found during an operation. </p>",
|
||||
"documentation":"<p> An entity was not found during an operation. </p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"OauthToken":{
|
||||
"type":"string",
|
||||
"max":100
|
||||
"max":100,
|
||||
"sensitive":true
|
||||
},
|
||||
"Platform":{
|
||||
"type":"string",
|
||||
|
|
@ -2518,22 +2562,22 @@
|
|||
"members":{
|
||||
"lastDeployTime":{
|
||||
"shape":"LastDeployTime",
|
||||
"documentation":"<p> Last Deploy Time of Production Branch. </p>"
|
||||
"documentation":"<p> The last deploy time of the production branch. </p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"Status",
|
||||
"documentation":"<p> Status of Production Branch. </p>"
|
||||
"documentation":"<p> The status of the production branch. </p>"
|
||||
},
|
||||
"thumbnailUrl":{
|
||||
"shape":"ThumbnailUrl",
|
||||
"documentation":"<p> Thumbnail URL for Production Branch. </p>"
|
||||
"documentation":"<p> The thumbnail URL for the production branch. </p>"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Branch Name for Production Branch. </p>"
|
||||
"documentation":"<p> The branch name for the production branch. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure with Production Branch information. </p>"
|
||||
"documentation":"<p> Describes the information about a production branch for an Amplify app. </p>"
|
||||
},
|
||||
"PullRequestEnvironmentName":{
|
||||
"type":"string",
|
||||
|
|
@ -2557,7 +2601,7 @@
|
|||
"code":{"shape":"Code"},
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Exception thrown when an operation fails due to non-existent resource. </p>",
|
||||
"documentation":"<p> An operation failed due to a non-existent resource. </p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2604,26 +2648,26 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch, for the Job. </p>",
|
||||
"documentation":"<p> The name for the branch, for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> The job id for this deployment, generated by create deployment request. </p>"
|
||||
"documentation":"<p> The job ID for this deployment, generated by the create deployment request. </p>"
|
||||
},
|
||||
"sourceUrl":{
|
||||
"shape":"SourceUrl",
|
||||
"documentation":"<p> The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip. </p>"
|
||||
"documentation":"<p> The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for start a deployment. </p>"
|
||||
"documentation":"<p> The request structure for the start a deployment request. </p>"
|
||||
},
|
||||
"StartDeploymentResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2631,10 +2675,10 @@
|
|||
"members":{
|
||||
"jobSummary":{
|
||||
"shape":"JobSummary",
|
||||
"documentation":"<p> Summary for the Job. </p>"
|
||||
"documentation":"<p> The summary for the job. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for start a deployment. </p>"
|
||||
"documentation":"<p> The result structure for the start a deployment request. </p>"
|
||||
},
|
||||
"StartJobRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2646,42 +2690,42 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch, for the Job. </p>",
|
||||
"documentation":"<p> The branch name for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> Unique Id for an existing job. Required for \"RETRY\" JobType. </p>"
|
||||
"documentation":"<p> The unique ID for an existing job. This is required if the value of <code>jobType</code> is <code>RETRY</code>. </p>"
|
||||
},
|
||||
"jobType":{
|
||||
"shape":"JobType",
|
||||
"documentation":"<p> Type for the Job. Available JobTypes are: \\n \"RELEASE\": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. \"RETRY\": Retry an existing job. JobId is required for this type of job. </p>"
|
||||
"documentation":"<p> Describes the type for the job. The job type <code>RELEASE</code> starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type <code>RETRY</code> retries an existing job. If the job type value is <code>RETRY</code>, the <code>jobId</code> is also required. </p>"
|
||||
},
|
||||
"jobReason":{
|
||||
"shape":"JobReason",
|
||||
"documentation":"<p> Descriptive reason for starting this job. </p>"
|
||||
"documentation":"<p> A descriptive reason for starting this job. </p>"
|
||||
},
|
||||
"commitId":{
|
||||
"shape":"CommitId",
|
||||
"documentation":"<p> Commit Id from 3rd party repository provider for the Job. </p>"
|
||||
"documentation":"<p> The commit ID from a third-party repository provider for the job. </p>"
|
||||
},
|
||||
"commitMessage":{
|
||||
"shape":"CommitMessage",
|
||||
"documentation":"<p> Commit message from 3rd party repository provider for the Job. </p>"
|
||||
"documentation":"<p> The commit message from a third-party repository provider for the job. </p>"
|
||||
},
|
||||
"commitTime":{
|
||||
"shape":"CommitTime",
|
||||
"documentation":"<p> Commit date / time for the Job. </p>"
|
||||
"documentation":"<p> The commit date and time for the job. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for Start job request. </p>"
|
||||
"documentation":"<p> The request structure for the start job request. </p>"
|
||||
},
|
||||
"StartJobResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2689,10 +2733,10 @@
|
|||
"members":{
|
||||
"jobSummary":{
|
||||
"shape":"JobSummary",
|
||||
"documentation":"<p> Summary for the Job. </p>"
|
||||
"documentation":"<p> The summary for the job. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for run job request. </p>"
|
||||
"documentation":"<p> The result structure for the run job request. </p>"
|
||||
},
|
||||
"StartTime":{"type":"timestamp"},
|
||||
"Status":{
|
||||
|
|
@ -2715,50 +2759,50 @@
|
|||
"members":{
|
||||
"stepName":{
|
||||
"shape":"StepName",
|
||||
"documentation":"<p> Name of the execution step. </p>"
|
||||
"documentation":"<p> The name of the execution step. </p>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"StartTime",
|
||||
"documentation":"<p> Start date/ time of the execution step. </p>"
|
||||
"documentation":"<p> The start date and time of the execution step. </p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"JobStatus",
|
||||
"documentation":"<p> Status of the execution step. </p>"
|
||||
"documentation":"<p> The status of the execution step. </p>"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"EndTime",
|
||||
"documentation":"<p> End date/ time of the execution step. </p>"
|
||||
"documentation":"<p> The end date and time of the execution step. </p>"
|
||||
},
|
||||
"logUrl":{
|
||||
"shape":"LogUrl",
|
||||
"documentation":"<p> URL to the logs for the execution step. </p>"
|
||||
"documentation":"<p> The URL to the logs for the execution step. </p>"
|
||||
},
|
||||
"artifactsUrl":{
|
||||
"shape":"ArtifactsUrl",
|
||||
"documentation":"<p> URL to the artifact for the execution step. </p>"
|
||||
"documentation":"<p> The URL to the artifact for the execution step. </p>"
|
||||
},
|
||||
"testArtifactsUrl":{
|
||||
"shape":"TestArtifactsUrl",
|
||||
"documentation":"<p> URL to the test artifact for the execution step. </p>"
|
||||
"documentation":"<p> The 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>"
|
||||
"documentation":"<p> The URL to the test configuration for the execution step. </p>"
|
||||
},
|
||||
"screenshots":{
|
||||
"shape":"Screenshots",
|
||||
"documentation":"<p> List of screenshot URLs for the execution step, if relevant. </p>"
|
||||
"documentation":"<p> The list of screenshot URLs for the execution step, if relevant. </p>"
|
||||
},
|
||||
"statusReason":{
|
||||
"shape":"StatusReason",
|
||||
"documentation":"<p> The reason for current step status. </p>"
|
||||
"documentation":"<p> The reason for the current step status. </p>"
|
||||
},
|
||||
"context":{
|
||||
"shape":"Context",
|
||||
"documentation":"<p> The context for current step, will include build image if step is build. </p>"
|
||||
"documentation":"<p> The context for the current step. Includes a build image if the step is build. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure for an execution step for an execution job, for an Amplify App. </p>"
|
||||
"documentation":"<p> Describes an execution step, for an execution job, for an Amplify app. </p>"
|
||||
},
|
||||
"StepName":{
|
||||
"type":"string",
|
||||
|
|
@ -2778,24 +2822,24 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch, for the Job. </p>",
|
||||
"documentation":"<p> The name for the branch, for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"jobId":{
|
||||
"shape":"JobId",
|
||||
"documentation":"<p> Unique Id for the Job. </p>",
|
||||
"documentation":"<p> The unique id for the job. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"jobId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for stop job request. </p>"
|
||||
"documentation":"<p> The request structure for the stop job request. </p>"
|
||||
},
|
||||
"StopJobResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -2803,10 +2847,10 @@
|
|||
"members":{
|
||||
"jobSummary":{
|
||||
"shape":"JobSummary",
|
||||
"documentation":"<p> Summary for the Job. </p>"
|
||||
"documentation":"<p> The summary for the job. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the stop job request. </p>"
|
||||
"documentation":"<p> The result structure for the stop job request. </p>"
|
||||
},
|
||||
"SubDomain":{
|
||||
"type":"structure",
|
||||
|
|
@ -2818,18 +2862,18 @@
|
|||
"members":{
|
||||
"subDomainSetting":{
|
||||
"shape":"SubDomainSetting",
|
||||
"documentation":"<p> Setting structure for the Subdomain. </p>"
|
||||
"documentation":"<p> Describes the settings for the subdomain. </p>"
|
||||
},
|
||||
"verified":{
|
||||
"shape":"Verified",
|
||||
"documentation":"<p> Verified status of the Subdomain </p>"
|
||||
"documentation":"<p> The verified status of the subdomain </p>"
|
||||
},
|
||||
"dnsRecord":{
|
||||
"shape":"DNSRecord",
|
||||
"documentation":"<p> DNS record for the Subdomain. </p>"
|
||||
"documentation":"<p> The DNS record for the subdomain. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Subdomain for the Domain Association. </p>"
|
||||
"documentation":"<p> The subdomain for the domain association. </p>"
|
||||
},
|
||||
"SubDomainSetting":{
|
||||
"type":"structure",
|
||||
|
|
@ -2840,14 +2884,14 @@
|
|||
"members":{
|
||||
"prefix":{
|
||||
"shape":"DomainPrefix",
|
||||
"documentation":"<p> Prefix setting for the Subdomain. </p>"
|
||||
"documentation":"<p> The prefix setting for the subdomain. </p>"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Branch name setting for the Subdomain. </p>"
|
||||
"documentation":"<p> The branch name setting for the subdomain. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Setting for the Subdomain. </p>"
|
||||
"documentation":"<p> Describes the settings for the subdomain. </p>"
|
||||
},
|
||||
"SubDomainSettings":{
|
||||
"type":"list",
|
||||
|
|
@ -2861,7 +2905,7 @@
|
|||
},
|
||||
"TTL":{
|
||||
"type":"string",
|
||||
"documentation":"<p> The content TTL for the website in seconds. </p>"
|
||||
"documentation":"<p> The content Time to Live (TTL) for the website in seconds. </p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
|
|
@ -2891,22 +2935,22 @@
|
|||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"documentation":"<p> Resource arn used to tag resource. </p>",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) to use to tag a resource. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
"tags":{
|
||||
"shape":"TagMap",
|
||||
"documentation":"<p> Tags used to tag resource. </p>"
|
||||
"documentation":"<p> The tags used to tag the resource. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure used to tag resource. </p>"
|
||||
"documentation":"<p> The request structure to tag a resource with a tag key and value. </p>"
|
||||
},
|
||||
"TagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p> Response for tag resource. </p>"
|
||||
"documentation":"<p> The response for the tag resource request. </p>"
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
|
|
@ -2943,7 +2987,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Exception thrown when an operation fails due to a lack of access. </p>",
|
||||
"documentation":"<p> An operation failed due to a lack of access. </p>",
|
||||
"error":{"httpStatusCode":401},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2956,24 +3000,24 @@
|
|||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"documentation":"<p> Resource arn used to untag resource. </p>",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) to use to untag a resource. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
"tagKeys":{
|
||||
"shape":"TagKeyList",
|
||||
"documentation":"<p> Tag keys used to untag resource. </p>",
|
||||
"documentation":"<p> The tag keys to use to untag a resource. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"tagKeys"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure used to untag resource. </p>"
|
||||
"documentation":"<p> The request structure for the untag resource request. </p>"
|
||||
},
|
||||
"UntagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p> Response for untag resource. </p>"
|
||||
"documentation":"<p> The response for the untag resource request. </p>"
|
||||
},
|
||||
"UpdateAppRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -2981,76 +3025,80 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p> Name for an Amplify App. </p>"
|
||||
"documentation":"<p> The name for an Amplify app. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for an Amplify App. </p>"
|
||||
"documentation":"<p> The description for an Amplify app. </p>"
|
||||
},
|
||||
"platform":{
|
||||
"shape":"Platform",
|
||||
"documentation":"<p> Platform for an Amplify App. </p>"
|
||||
"documentation":"<p> The platform for an Amplify app. </p>"
|
||||
},
|
||||
"iamServiceRoleArn":{
|
||||
"shape":"ServiceRoleArn",
|
||||
"documentation":"<p> IAM service role for an Amplify App. </p>"
|
||||
"documentation":"<p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>"
|
||||
},
|
||||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p> Environment Variables for an Amplify App. </p>"
|
||||
"documentation":"<p> The environment variables for an Amplify app. </p>"
|
||||
},
|
||||
"enableBranchAutoBuild":{
|
||||
"shape":"EnableAutoBuild",
|
||||
"documentation":"<p> Enables branch auto-building for an Amplify App. </p>"
|
||||
"documentation":"<p> Enables branch auto-building for an Amplify app. </p>"
|
||||
},
|
||||
"enableBranchAutoDeletion":{
|
||||
"shape":"EnableBranchAutoDeletion",
|
||||
"documentation":"<p> Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. </p>"
|
||||
},
|
||||
"enableBasicAuth":{
|
||||
"shape":"EnableBasicAuth",
|
||||
"documentation":"<p> Enables Basic Authorization for an Amplify App. </p>"
|
||||
"documentation":"<p> Enables basic authorization for an Amplify app. </p>"
|
||||
},
|
||||
"basicAuthCredentials":{
|
||||
"shape":"BasicAuthCredentials",
|
||||
"documentation":"<p> Basic Authorization credentials for an Amplify App. </p>"
|
||||
"documentation":"<p> The basic authorization credentials for an Amplify app. </p>"
|
||||
},
|
||||
"customRules":{
|
||||
"shape":"CustomRules",
|
||||
"documentation":"<p> Custom redirect / rewrite rules for an Amplify App. </p>"
|
||||
"documentation":"<p> The custom redirect and rewrite rules for an Amplify app. </p>"
|
||||
},
|
||||
"buildSpec":{
|
||||
"shape":"BuildSpec",
|
||||
"documentation":"<p> BuildSpec for an Amplify App. </p>"
|
||||
"documentation":"<p> The build specification (build spec) for an Amplify app. </p>"
|
||||
},
|
||||
"enableAutoBranchCreation":{
|
||||
"shape":"EnableAutoBranchCreation",
|
||||
"documentation":"<p> Enables automated branch creation for the Amplify App. </p>"
|
||||
"documentation":"<p> Enables automated branch creation for the Amplify app. </p>"
|
||||
},
|
||||
"autoBranchCreationPatterns":{
|
||||
"shape":"AutoBranchCreationPatterns",
|
||||
"documentation":"<p> Automated branch creation glob patterns for the Amplify App. </p>"
|
||||
"documentation":"<p> Describes the automated branch creation glob patterns for the Amplify app. </p>"
|
||||
},
|
||||
"autoBranchCreationConfig":{
|
||||
"shape":"AutoBranchCreationConfig",
|
||||
"documentation":"<p> Automated branch creation branchConfig for the Amplify App. </p>"
|
||||
"documentation":"<p> The automated branch creation configuration for the Amplify app. </p>"
|
||||
},
|
||||
"repository":{
|
||||
"shape":"Repository",
|
||||
"documentation":"<p> Repository for an Amplify App </p>"
|
||||
"documentation":"<p> The name of the 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>"
|
||||
"documentation":"<p> The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The 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> The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for update App request. </p>"
|
||||
"documentation":"<p> The request structure for the update app request. </p>"
|
||||
},
|
||||
"UpdateAppResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3058,10 +3106,10 @@
|
|||
"members":{
|
||||
"app":{
|
||||
"shape":"App",
|
||||
"documentation":"<p> App structure for the updated App. </p>"
|
||||
"documentation":"<p> Represents the updated Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for an Amplify App update request. </p>"
|
||||
"documentation":"<p> The result structure for an Amplify app update request. </p>"
|
||||
},
|
||||
"UpdateBranchRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -3072,27 +3120,27 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for the branch. </p>",
|
||||
"documentation":"<p> The name for the branch. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"branchName"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for the branch. </p>"
|
||||
"documentation":"<p> The description for the branch. </p>"
|
||||
},
|
||||
"framework":{
|
||||
"shape":"Framework",
|
||||
"documentation":"<p> Framework for the branch. </p>"
|
||||
"documentation":"<p> The framework for the branch. </p>"
|
||||
},
|
||||
"stage":{
|
||||
"shape":"Stage",
|
||||
"documentation":"<p> Stage for the branch. </p>"
|
||||
"documentation":"<p> Describes the current stage for the branch. </p>"
|
||||
},
|
||||
"enableNotification":{
|
||||
"shape":"EnableNotification",
|
||||
|
|
@ -3104,42 +3152,42 @@
|
|||
},
|
||||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p> Environment Variables for the branch. </p>"
|
||||
"documentation":"<p> The environment variables for the branch. </p>"
|
||||
},
|
||||
"basicAuthCredentials":{
|
||||
"shape":"BasicAuthCredentials",
|
||||
"documentation":"<p> Basic Authorization credentials for the branch. </p>"
|
||||
"documentation":"<p> The basic authorization credentials for the branch. </p>"
|
||||
},
|
||||
"enableBasicAuth":{
|
||||
"shape":"EnableBasicAuth",
|
||||
"documentation":"<p> Enables Basic Auth for the branch. </p>"
|
||||
"documentation":"<p> Enables basic authorization for the branch. </p>"
|
||||
},
|
||||
"buildSpec":{
|
||||
"shape":"BuildSpec",
|
||||
"documentation":"<p> BuildSpec for the branch. </p>"
|
||||
"documentation":"<p> The build specification (build spec) for the branch. </p>"
|
||||
},
|
||||
"ttl":{
|
||||
"shape":"TTL",
|
||||
"documentation":"<p> The content TTL for the website in seconds. </p>"
|
||||
"documentation":"<p> The content Time to Live (TTL) for the website in seconds. </p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"DisplayName",
|
||||
"documentation":"<p> Display name for a branch, will use as the default domain prefix. </p>"
|
||||
"documentation":"<p> The display name for a branch. This is used as the default domain prefix. </p>"
|
||||
},
|
||||
"enablePullRequestPreview":{
|
||||
"shape":"EnablePullRequestPreview",
|
||||
"documentation":"<p> Enables Pull Request Preview for this branch. </p>"
|
||||
"documentation":"<p> Enables pull request preview for this branch. </p>"
|
||||
},
|
||||
"pullRequestEnvironmentName":{
|
||||
"shape":"PullRequestEnvironmentName",
|
||||
"documentation":"<p> The Amplify Environment name for the pull request. </p>"
|
||||
"documentation":"<p> The Amplify environment name for the pull request. </p>"
|
||||
},
|
||||
"backendEnvironmentArn":{
|
||||
"shape":"BackendEnvironmentArn",
|
||||
"documentation":"<p> ARN for a Backend Environment, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for update branch request. </p>"
|
||||
"documentation":"<p> The request structure for the update branch request. </p>"
|
||||
},
|
||||
"UpdateBranchResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3147,10 +3195,10 @@
|
|||
"members":{
|
||||
"branch":{
|
||||
"shape":"Branch",
|
||||
"documentation":"<p> Branch structure for an Amplify App. </p>"
|
||||
"documentation":"<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for update branch request. </p>"
|
||||
"documentation":"<p> The result structure for the update branch request. </p>"
|
||||
},
|
||||
"UpdateDomainAssociationRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -3162,26 +3210,34 @@
|
|||
"members":{
|
||||
"appId":{
|
||||
"shape":"AppId",
|
||||
"documentation":"<p> Unique Id for an Amplify App. </p>",
|
||||
"documentation":"<p> The unique ID for an Amplify app. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"domainName":{
|
||||
"shape":"DomainName",
|
||||
"documentation":"<p> Name of the domain. </p>",
|
||||
"documentation":"<p> The name of the domain. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"domainName"
|
||||
},
|
||||
"enableAutoSubDomain":{
|
||||
"shape":"EnableAutoSubDomain",
|
||||
"documentation":"<p> Enables automated creation of Subdomains for branches. (Currently not supported) </p>"
|
||||
"documentation":"<p> Enables the automated creation of subdomains for branches. </p>"
|
||||
},
|
||||
"subDomainSettings":{
|
||||
"shape":"SubDomainSettings",
|
||||
"documentation":"<p> Setting structure for the Subdomain. </p>"
|
||||
"documentation":"<p> Describes the settings for the subdomain. </p>"
|
||||
},
|
||||
"autoSubDomainCreationPatterns":{
|
||||
"shape":"AutoSubDomainCreationPatterns",
|
||||
"documentation":"<p> Sets the branch patterns for automatic subdomain creation. </p>"
|
||||
},
|
||||
"autoSubDomainIAMRole":{
|
||||
"shape":"AutoSubDomainIAMRole",
|
||||
"documentation":"<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for update Domain Association request. </p>"
|
||||
"documentation":"<p> The request structure for the update domain association request. </p>"
|
||||
},
|
||||
"UpdateDomainAssociationResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3189,10 +3245,10 @@
|
|||
"members":{
|
||||
"domainAssociation":{
|
||||
"shape":"DomainAssociation",
|
||||
"documentation":"<p> Domain Association structure. </p>"
|
||||
"documentation":"<p> Describes a domain association, which associates a custom domain with an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the update Domain Association request. </p>"
|
||||
"documentation":"<p> The result structure for the update domain association request. </p>"
|
||||
},
|
||||
"UpdateTime":{"type":"timestamp"},
|
||||
"UpdateWebhookRequest":{
|
||||
|
|
@ -3201,20 +3257,20 @@
|
|||
"members":{
|
||||
"webhookId":{
|
||||
"shape":"WebhookId",
|
||||
"documentation":"<p> Unique Id for a webhook. </p>",
|
||||
"documentation":"<p> The unique ID for a webhook. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"webhookId"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The name for a branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for a webhook. </p>"
|
||||
"documentation":"<p> The description for a webhook. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Request structure for update webhook request. </p>"
|
||||
"documentation":"<p> The request structure for the update webhook request. </p>"
|
||||
},
|
||||
"UpdateWebhookResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -3222,10 +3278,10 @@
|
|||
"members":{
|
||||
"webhook":{
|
||||
"shape":"Webhook",
|
||||
"documentation":"<p> Webhook structure. </p>"
|
||||
"documentation":"<p> Describes a webhook that connects repository events to an Amplify app. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Result structure for the update webhook request. </p>"
|
||||
"documentation":"<p> The result structure for the update webhook request. </p>"
|
||||
},
|
||||
"UploadUrl":{
|
||||
"type":"string",
|
||||
|
|
@ -3246,34 +3302,34 @@
|
|||
"members":{
|
||||
"webhookArn":{
|
||||
"shape":"WebhookArn",
|
||||
"documentation":"<p> ARN for the webhook. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) for the webhook. </p>"
|
||||
},
|
||||
"webhookId":{
|
||||
"shape":"WebhookId",
|
||||
"documentation":"<p> Id of the webhook. </p>"
|
||||
"documentation":"<p> The ID of the webhook. </p>"
|
||||
},
|
||||
"webhookUrl":{
|
||||
"shape":"WebhookUrl",
|
||||
"documentation":"<p> Url of the webhook. </p>"
|
||||
"documentation":"<p> The URL of the webhook. </p>"
|
||||
},
|
||||
"branchName":{
|
||||
"shape":"BranchName",
|
||||
"documentation":"<p> Name for a branch, part of an Amplify App. </p>"
|
||||
"documentation":"<p> The name for a branch that is part of an Amplify app. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p> Description for a webhook. </p>"
|
||||
"documentation":"<p> The description for a webhook. </p>"
|
||||
},
|
||||
"createTime":{
|
||||
"shape":"CreateTime",
|
||||
"documentation":"<p> Create date / time for a webhook. </p>"
|
||||
"documentation":"<p> The create date and time for a webhook. </p>"
|
||||
},
|
||||
"updateTime":{
|
||||
"shape":"UpdateTime",
|
||||
"documentation":"<p> Update date / time for a webhook. </p>"
|
||||
"documentation":"<p> Updates the date and time for a webhook. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Structure for webhook, which associates a webhook with an Amplify App. </p>"
|
||||
"documentation":"<p> Describes a webhook that connects repository events to an Amplify app. </p>"
|
||||
},
|
||||
"WebhookArn":{
|
||||
"type":"string",
|
||||
|
|
@ -3292,5 +3348,5 @@
|
|||
"member":{"shape":"Webhook"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Amplify is a fully managed continuous deployment and hosting service for modern web apps. </p>"
|
||||
"documentation":"<p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify Console User Guide</a>. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework.</a> </p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -35,6 +35,18 @@
|
|||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "tags"
|
||||
},
|
||||
"ListGatewayRoutes": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "gatewayRoutes"
|
||||
},
|
||||
"ListVirtualGateways": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "virtualGateways"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -13,6 +13,48 @@
|
|||
},
|
||||
"documentation": "<p>AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control microservices. App Mesh standardizes how your microservices communicate, giving you\n end-to-end visibility and helping to ensure high availability for your applications.</p>\n <p>App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS,\n Kubernetes on AWS, and Amazon EC2.</p>\n <note>\n <p>App Mesh supports microservice applications that use service discovery naming for their\n components. For more information about service discovery on Amazon ECS, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. Kubernetes\n <code>kube-dns</code> and <code>coredns</code> are supported. For more information,\n see <a href=\"https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/\">DNS\n for Services and Pods</a> in the Kubernetes documentation.</p>\n </note>",
|
||||
"operations": {
|
||||
"CreateGatewayRoute": {
|
||||
"name": "CreateGatewayRoute",
|
||||
"http": {
|
||||
"method": "PUT",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "CreateGatewayRouteInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "CreateGatewayRouteOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ConflictException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "LimitExceededException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Creates a gateway route.</p>\n <p>A gateway route is attached to a virtual gateway and routes traffic to an existing\n virtual service. If a route matches a request, it can distribute traffic to a target virtual service.</p>\n <p>For more information about gateway routes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html\">Gateway routes</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"CreateMesh": {
|
||||
"name": "CreateMesh",
|
||||
"http": {
|
||||
|
|
@ -97,6 +139,48 @@
|
|||
"documentation": "<p>Creates a route that is associated with a virtual router.</p>\n <p> You can route several different protocols and define a retry policy for a route.\n Traffic can be routed to one or more virtual nodes.</p>\n <p>For more information about routes, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html\">Routes</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"CreateVirtualGateway": {
|
||||
"name": "CreateVirtualGateway",
|
||||
"http": {
|
||||
"method": "PUT",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateways",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "CreateVirtualGatewayInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "CreateVirtualGatewayOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ConflictException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "LimitExceededException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Creates a virtual gateway.</p>\n <p>A virtual gateway allows resources outside your mesh to communicate to resources that\n are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS\n task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which\n represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.</p>\n <p>For more information about virtual gateways, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html\">Virtual gateways</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"CreateVirtualNode": {
|
||||
"name": "CreateVirtualNode",
|
||||
"http": {
|
||||
|
|
@ -223,6 +307,45 @@
|
|||
"documentation": "<p>Creates a virtual service within a service mesh.</p>\n <p>A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its <code>virtualServiceName</code>, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.</p>\n <p>For more information about virtual services, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html\">Virtual services</a>.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"DeleteGatewayRoute": {
|
||||
"name": "DeleteGatewayRoute",
|
||||
"http": {
|
||||
"method": "DELETE",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "DeleteGatewayRouteInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "DeleteGatewayRouteOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ResourceInUseException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Deletes an existing gateway route.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"DeleteMesh": {
|
||||
"name": "DeleteMesh",
|
||||
"http": {
|
||||
|
|
@ -301,6 +424,45 @@
|
|||
"documentation": "<p>Deletes an existing route.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"DeleteVirtualGateway": {
|
||||
"name": "DeleteVirtualGateway",
|
||||
"http": {
|
||||
"method": "DELETE",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "DeleteVirtualGatewayInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "DeleteVirtualGatewayOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ResourceInUseException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway\n routes are associated to it.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"DeleteVirtualNode": {
|
||||
"name": "DeleteVirtualNode",
|
||||
"http": {
|
||||
|
|
@ -418,6 +580,41 @@
|
|||
"documentation": "<p>Deletes an existing virtual service.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"DescribeGatewayRoute": {
|
||||
"name": "DescribeGatewayRoute",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "DescribeGatewayRouteInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "DescribeGatewayRouteOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Describes an existing gateway route.</p>"
|
||||
},
|
||||
"DescribeMesh": {
|
||||
"name": "DescribeMesh",
|
||||
"http": {
|
||||
|
|
@ -488,6 +685,41 @@
|
|||
],
|
||||
"documentation": "<p>Describes an existing route.</p>"
|
||||
},
|
||||
"DescribeVirtualGateway": {
|
||||
"name": "DescribeVirtualGateway",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "DescribeVirtualGatewayInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "DescribeVirtualGatewayOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Describes an existing virtual gateway.</p>"
|
||||
},
|
||||
"DescribeVirtualNode": {
|
||||
"name": "DescribeVirtualNode",
|
||||
"http": {
|
||||
|
|
@ -593,6 +825,41 @@
|
|||
],
|
||||
"documentation": "<p>Describes an existing virtual service.</p>"
|
||||
},
|
||||
"ListGatewayRoutes": {
|
||||
"name": "ListGatewayRoutes",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "ListGatewayRoutesInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "ListGatewayRoutesOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Returns a list of existing gateway routes that are associated to a virtual\n gateway.</p>"
|
||||
},
|
||||
"ListMeshes": {
|
||||
"name": "ListMeshes",
|
||||
"http": {
|
||||
|
|
@ -698,6 +965,41 @@
|
|||
],
|
||||
"documentation": "<p>List the tags for an App Mesh resource.</p>"
|
||||
},
|
||||
"ListVirtualGateways": {
|
||||
"name": "ListVirtualGateways",
|
||||
"http": {
|
||||
"method": "GET",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateways",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "ListVirtualGatewaysInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "ListVirtualGatewaysOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Returns a list of existing virtual gateways in a service mesh.</p>"
|
||||
},
|
||||
"ListVirtualNodes": {
|
||||
"name": "ListVirtualNodes",
|
||||
"http": {
|
||||
|
|
@ -878,6 +1180,48 @@
|
|||
"documentation": "<p>Deletes specified tags from a resource.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"UpdateGatewayRoute": {
|
||||
"name": "UpdateGatewayRoute",
|
||||
"http": {
|
||||
"method": "PUT",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "UpdateGatewayRouteInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "UpdateGatewayRouteOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ConflictException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "LimitExceededException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Updates an existing gateway route that is associated to a specified virtual gateway in a\n service mesh.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"UpdateMesh": {
|
||||
"name": "UpdateMesh",
|
||||
"http": {
|
||||
|
|
@ -959,6 +1303,48 @@
|
|||
"documentation": "<p>Updates an existing route for a specified service mesh and virtual router.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"UpdateVirtualGateway": {
|
||||
"name": "UpdateVirtualGateway",
|
||||
"http": {
|
||||
"method": "PUT",
|
||||
"requestUri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}",
|
||||
"responseCode": 200
|
||||
},
|
||||
"input": {
|
||||
"shape": "UpdateVirtualGatewayInput"
|
||||
},
|
||||
"output": {
|
||||
"shape": "UpdateVirtualGatewayOutput"
|
||||
},
|
||||
"errors": [
|
||||
{
|
||||
"shape": "BadRequestException"
|
||||
},
|
||||
{
|
||||
"shape": "ConflictException"
|
||||
},
|
||||
{
|
||||
"shape": "ForbiddenException"
|
||||
},
|
||||
{
|
||||
"shape": "InternalServerErrorException"
|
||||
},
|
||||
{
|
||||
"shape": "LimitExceededException"
|
||||
},
|
||||
{
|
||||
"shape": "NotFoundException"
|
||||
},
|
||||
{
|
||||
"shape": "ServiceUnavailableException"
|
||||
},
|
||||
{
|
||||
"shape": "TooManyRequestsException"
|
||||
}
|
||||
],
|
||||
"documentation": "<p>Updates an existing virtual gateway in a specified service mesh.</p>",
|
||||
"idempotent": true
|
||||
},
|
||||
"UpdateVirtualNode": {
|
||||
"name": "UpdateVirtualNode",
|
||||
"http": {
|
||||
|
|
@ -1204,6 +1590,82 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"CreateVirtualGatewayInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to create the virtual gateway in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualGatewaySpec",
|
||||
"documentation": "<p>The virtual gateway specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the virtual gateway to assist with\n categorization and organization. Each tag consists of a key and an optional value, both of\n which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name to use for the virtual gateway.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateVirtualGatewayInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual gateway resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualGatewaySpec",
|
||||
"documentation": "<p>The new virtual gateway specification to apply. This overwrites the existing\n data.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ResourceMetadata": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1242,7 +1704,7 @@
|
|||
},
|
||||
"version": {
|
||||
"shape": "Long",
|
||||
"documentation": "<p>The version of the resource. Resources are created at version 1, and this version is\n incremented each time that they're updated.</p>"
|
||||
"documentation": "<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents metadata for a resource.</p>"
|
||||
|
|
@ -1325,6 +1787,19 @@
|
|||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"HttpGatewayRouteMatch": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"prefix"
|
||||
],
|
||||
"members": {
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
},
|
||||
"GrpcRouteMetadataList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -1382,6 +1857,12 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the health check policy for a virtual node's listener.</p>"
|
||||
},
|
||||
"VirtualGatewayHealthCheckTimeoutMillis": {
|
||||
"type": "long",
|
||||
"box": true,
|
||||
"min": 2000,
|
||||
"max": 60000
|
||||
},
|
||||
"EgressFilter": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1411,15 +1892,54 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a client policy.</p>"
|
||||
},
|
||||
"VirtualGatewayHealthCheckIntervalMillis": {
|
||||
"type": "long",
|
||||
"box": true,
|
||||
"min": 5000,
|
||||
"max": 300000
|
||||
},
|
||||
"Boolean": {
|
||||
"type": "boolean",
|
||||
"box": true
|
||||
},
|
||||
"VirtualGatewaySpec": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"listeners"
|
||||
],
|
||||
"members": {
|
||||
"backendDefaults": {
|
||||
"shape": "VirtualGatewayBackendDefaults",
|
||||
"documentation": "<p>A reference to an object that represents the defaults for backends.</p>"
|
||||
},
|
||||
"listeners": {
|
||||
"shape": "VirtualGatewayListeners",
|
||||
"documentation": "<p>The listeners that the mesh endpoint is expected to receive inbound traffic from. You\n can specify one listener.</p>"
|
||||
},
|
||||
"logging": {
|
||||
"shape": "VirtualGatewayLogging"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the specification of a service mesh resource.</p>"
|
||||
},
|
||||
"HttpRetryPolicyEvent": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
"max": 25
|
||||
},
|
||||
"VirtualGatewayFileAccessLog": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"path"
|
||||
],
|
||||
"members": {
|
||||
"path": {
|
||||
"shape": "FilePath",
|
||||
"documentation": "<p>The file path to write access logs to. You can use <code>/dev/stdout</code> to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n <code>awslogs</code>, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents an access log file.</p>"
|
||||
},
|
||||
"DescribeVirtualServiceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1434,6 +1954,52 @@
|
|||
"documentation": "",
|
||||
"payload": "virtualService"
|
||||
},
|
||||
"CreateGatewayRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRouteName",
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"gatewayRouteName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name to use for the gateway route.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to create the gateway route in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "GatewayRouteSpec",
|
||||
"documentation": "<p>The gateway route specification to apply.</p>"
|
||||
},
|
||||
"tags": {
|
||||
"shape": "TagList",
|
||||
"documentation": "<p>Optional metadata that you can apply to the gateway route to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway to associate the gateway route with. If the virtual\n gateway is in a shared mesh, then you must be the owner of the virtual gateway\n resource.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CertificateAuthorityArns": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -1462,6 +2028,38 @@
|
|||
"max": 1024,
|
||||
"pattern": "((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^.$)"
|
||||
},
|
||||
"VirtualGatewayData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"metadata",
|
||||
"spec",
|
||||
"status",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the virtual gateway resides in.</p>"
|
||||
},
|
||||
"metadata": {
|
||||
"shape": "ResourceMetadata"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "VirtualGatewaySpec",
|
||||
"documentation": "<p>The specifications of the virtual gateway.</p>"
|
||||
},
|
||||
"status": {
|
||||
"shape": "VirtualGatewayStatus",
|
||||
"documentation": "<p>The current status of the virtual gateway.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual gateway returned by a describe operation.</p>"
|
||||
},
|
||||
"CreateRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1476,6 +2074,27 @@
|
|||
"documentation": "",
|
||||
"payload": "route"
|
||||
},
|
||||
"VirtualGatewayListener": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"portMapping"
|
||||
],
|
||||
"members": {
|
||||
"healthCheck": {
|
||||
"shape": "VirtualGatewayHealthCheckPolicy",
|
||||
"documentation": "<p>The health check information for the listener.</p>"
|
||||
},
|
||||
"portMapping": {
|
||||
"shape": "VirtualGatewayPortMapping",
|
||||
"documentation": "<p>The port mapping information for the listener.</p>"
|
||||
},
|
||||
"tls": {
|
||||
"shape": "VirtualGatewayListenerTls",
|
||||
"documentation": "<p>A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a listener for a virtual gateway.</p>"
|
||||
},
|
||||
"DnsServiceDiscovery": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1489,6 +2108,37 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the DNS service discovery information for your virtual\n node.</p>"
|
||||
},
|
||||
"VirtualGatewayPortMapping": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"port",
|
||||
"protocol"
|
||||
],
|
||||
"members": {
|
||||
"port": {
|
||||
"shape": "PortNumber",
|
||||
"documentation": "<p>The port used for the port mapping. Specify one protocol.</p>"
|
||||
},
|
||||
"protocol": {
|
||||
"shape": "VirtualGatewayPortProtocol",
|
||||
"documentation": "<p>The protocol used for the port mapping.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a port mapping.</p>"
|
||||
},
|
||||
"DeleteVirtualGatewayOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualGateway"
|
||||
],
|
||||
"members": {
|
||||
"virtualGateway": {
|
||||
"shape": "VirtualGatewayData",
|
||||
"documentation": "<p>The virtual gateway that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "virtualGateway"
|
||||
},
|
||||
"DeleteRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1562,12 +2212,36 @@
|
|||
"members": { },
|
||||
"documentation": ""
|
||||
},
|
||||
"ListGatewayRoutesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"TcpRetryPolicyEvent": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"connection-error"
|
||||
]
|
||||
},
|
||||
"VirtualGatewayListenerTls": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificate",
|
||||
"mode"
|
||||
],
|
||||
"members": {
|
||||
"certificate": {
|
||||
"shape": "VirtualGatewayListenerTlsCertificate",
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) certificate.</p>"
|
||||
},
|
||||
"mode": {
|
||||
"shape": "VirtualGatewayListenerTlsMode",
|
||||
"documentation": "<p>Specify one of the following modes.</p>\n <ul>\n <li>\n <p>\n <b/>STRICT – Listener only accepts connections with TLS\n enabled. </p>\n </li>\n <li>\n <p>\n <b/>PERMISSIVE – Listener accepts connections with or\n without TLS enabled.</p>\n </li>\n <li>\n <p>\n <b/>DISABLED – Listener only accepts connections without\n TLS. </p>\n </li>\n </ul>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the Transport Layer Security (TLS) properties for a listener.</p>"
|
||||
},
|
||||
"Backend": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1596,6 +2270,63 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualGatewayListenerTlsFileCertificate": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificateChain",
|
||||
"privateKey"
|
||||
],
|
||||
"members": {
|
||||
"certificateChain": {
|
||||
"shape": "FilePath",
|
||||
"documentation": "<p>The certificate chain for the certificate.</p>"
|
||||
},
|
||||
"privateKey": {
|
||||
"shape": "FilePath",
|
||||
"documentation": "<p>The private key for a certificate stored on the file system of the mesh endpoint that\n the proxy is running on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a local file certificate.\n The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
|
||||
},
|
||||
"ListGatewayRoutesInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListGatewayRoutesLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListGatewayRoutes</code> in paginated\n output. When you use this parameter, <code>ListGatewayRoutes</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListGatewayRoutes</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListGatewayRoutes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list gateway routes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListGatewayRoutes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway to list gateway routes in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"VirtualRouterData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1653,6 +2384,47 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualGatewayHealthCheckPolicy": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"healthyThreshold",
|
||||
"intervalMillis",
|
||||
"protocol",
|
||||
"timeoutMillis",
|
||||
"unhealthyThreshold"
|
||||
],
|
||||
"members": {
|
||||
"healthyThreshold": {
|
||||
"shape": "VirtualGatewayHealthCheckThreshold",
|
||||
"documentation": "<p>The number of consecutive successful health checks that must occur before declaring the\n listener healthy.</p>"
|
||||
},
|
||||
"intervalMillis": {
|
||||
"shape": "VirtualGatewayHealthCheckIntervalMillis",
|
||||
"documentation": "<p>The time period in milliseconds between each health check execution.</p>"
|
||||
},
|
||||
"path": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The destination path for the health check request. This value is only used if the\n specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.</p>"
|
||||
},
|
||||
"port": {
|
||||
"shape": "PortNumber",
|
||||
"documentation": "<p>The destination port for the health check request. This port must match the port defined\n in the <a>PortMapping</a> for the listener.</p>"
|
||||
},
|
||||
"protocol": {
|
||||
"shape": "VirtualGatewayPortProtocol",
|
||||
"documentation": "<p>The protocol for the health check request. If you specify <code>grpc</code>, then your\n service must conform to the <a href=\"https://github.com/grpc/grpc/blob/master/doc/health-checking.md\">GRPC Health\n Checking Protocol</a>.</p>"
|
||||
},
|
||||
"timeoutMillis": {
|
||||
"shape": "VirtualGatewayHealthCheckTimeoutMillis",
|
||||
"documentation": "<p>The amount of time to wait when receiving a response from the health check, in\n milliseconds.</p>"
|
||||
},
|
||||
"unhealthyThreshold": {
|
||||
"shape": "VirtualGatewayHealthCheckThreshold",
|
||||
"documentation": "<p>The number of consecutive failed health checks that must occur before declaring a\n virtual gateway unhealthy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the health check policy for a virtual gateway's\n listener.</p>"
|
||||
},
|
||||
"CreateVirtualRouterInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1759,6 +2531,20 @@
|
|||
"min": 1,
|
||||
"max": 25
|
||||
},
|
||||
"VirtualGatewayListenerTlsCertificate": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"acm": {
|
||||
"shape": "VirtualGatewayListenerTlsAcmCertificate",
|
||||
"documentation": "<p>A reference to an object that represents an AWS Certicate Manager (ACM) certificate.</p>"
|
||||
},
|
||||
"file": {
|
||||
"shape": "VirtualGatewayListenerTlsFileCertificate",
|
||||
"documentation": "<p>A reference to an object that represents a local file certificate.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a listener's Transport Layer Security (TLS) certificate.</p>"
|
||||
},
|
||||
"ListenerTlsCertificate": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1795,6 +2581,19 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the specification of a virtual router.</p>"
|
||||
},
|
||||
"GatewayRouteVirtualService": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualServiceName"
|
||||
],
|
||||
"members": {
|
||||
"virtualServiceName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual service that traffic is routed to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the virtual service that traffic is routed to.</p>"
|
||||
},
|
||||
"VirtualNodeSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1846,6 +2645,24 @@
|
|||
"min": 1,
|
||||
"max": 1
|
||||
},
|
||||
"GatewayRouteSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"grpcRoute": {
|
||||
"shape": "GrpcGatewayRoute",
|
||||
"documentation": "<p>An object that represents the specification of a gRPC gateway route.</p>"
|
||||
},
|
||||
"http2Route": {
|
||||
"shape": "HttpGatewayRoute",
|
||||
"documentation": "<p>An object that represents the specification of an HTTP/2 gateway route.</p>"
|
||||
},
|
||||
"httpRoute": {
|
||||
"shape": "HttpGatewayRoute",
|
||||
"documentation": "<p>An object that represents the specification of an HTTP gateway route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a gateway route specification. Specify one gateway route\n type.</p>"
|
||||
},
|
||||
"PortSet": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -1881,6 +2698,16 @@
|
|||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"VirtualGatewayBackendDefaults": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"clientPolicy": {
|
||||
"shape": "VirtualGatewayClientPolicy",
|
||||
"documentation": "<p>A reference to an object that represents a client policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the default properties for a backend.</p>"
|
||||
},
|
||||
"ListenerTimeout": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1888,15 +2715,19 @@
|
|||
"shape": "GrpcTimeout"
|
||||
},
|
||||
"http": {
|
||||
"shape": "HttpTimeout"
|
||||
"shape": "HttpTimeout",
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
},
|
||||
"http2": {
|
||||
"shape": "HttpTimeout"
|
||||
"shape": "HttpTimeout",
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
},
|
||||
"tcp": {
|
||||
"shape": "TcpTimeout"
|
||||
"shape": "TcpTimeout",
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents timeouts for different protocols.</p>"
|
||||
},
|
||||
"MeshList": {
|
||||
"type": "list",
|
||||
|
|
@ -1909,6 +2740,40 @@
|
|||
"box": true,
|
||||
"min": 0
|
||||
},
|
||||
"DescribeGatewayRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRouteName",
|
||||
"meshName",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRouteName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the gateway route to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "gatewayRouteName"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the gateway route resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway that the gateway route is associated with.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TlsValidationContextTrust": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -1941,6 +2806,11 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a port mapping.</p>"
|
||||
},
|
||||
"VirtualGatewayHealthCheckThreshold": {
|
||||
"type": "integer",
|
||||
"min": 2,
|
||||
"max": 10
|
||||
},
|
||||
"ListVirtualServicesOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -1982,6 +2852,61 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a target and its relative weight. Traffic is distributed\n across targets according to their relative weight. For example, a weighted target with a\n relative weight of 50 receives five times as much traffic as one with a relative weight of\n 10. The total weight for all targets combined must be less than or equal to 100.</p>"
|
||||
},
|
||||
"GrpcGatewayRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action",
|
||||
"match"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "GrpcGatewayRouteAction",
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "GrpcGatewayRouteMatch",
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a gRPC gateway route.</p>"
|
||||
},
|
||||
"GatewayRouteData": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRouteName",
|
||||
"meshName",
|
||||
"metadata",
|
||||
"spec",
|
||||
"status",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRouteName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the gateway route.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the resource resides in. </p>"
|
||||
},
|
||||
"metadata": {
|
||||
"shape": "ResourceMetadata"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "GatewayRouteSpec",
|
||||
"documentation": "<p>The specifications of the gateway route.</p>"
|
||||
},
|
||||
"status": {
|
||||
"shape": "GatewayRouteStatus",
|
||||
"documentation": "<p>The status of the gateway route.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The virtual gateway that the gateway route is associated with.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a gateway route returned by a describe operation.</p>"
|
||||
},
|
||||
"RouteRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2215,6 +3140,28 @@
|
|||
"documentation": "",
|
||||
"payload": "mesh"
|
||||
},
|
||||
"VirtualGatewayClientPolicyTls": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"validation"
|
||||
],
|
||||
"members": {
|
||||
"enforce": {
|
||||
"shape": "Boolean",
|
||||
"box": true,
|
||||
"documentation": "<p>Whether the policy is enforced. The default is <code>True</code>, if a value isn't\n specified.</p>"
|
||||
},
|
||||
"ports": {
|
||||
"shape": "PortSet",
|
||||
"documentation": "<p>One or more ports that the policy is enforced for.</p>"
|
||||
},
|
||||
"validation": {
|
||||
"shape": "VirtualGatewayTlsValidationContext",
|
||||
"documentation": "<p>A reference to an object that represents a TLS validation context.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) client policy.</p>"
|
||||
},
|
||||
"EgressFilterType": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
|
|
@ -2230,6 +3177,40 @@
|
|||
"Hostname": {
|
||||
"type": "string"
|
||||
},
|
||||
"VirtualGatewayStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "VirtualGatewayStatusCode",
|
||||
"documentation": "<p>The current status.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the status of the mesh resource.</p>"
|
||||
},
|
||||
"GatewayRouteStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"status"
|
||||
],
|
||||
"members": {
|
||||
"status": {
|
||||
"shape": "GatewayRouteStatusCode",
|
||||
"documentation": "<p>The current status for the gateway route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the current status of a gateway route.</p>"
|
||||
},
|
||||
"VirtualGatewayListeners": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "VirtualGatewayListener"
|
||||
},
|
||||
"min": 0,
|
||||
"max": 1
|
||||
},
|
||||
"TagResourceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2250,6 +3231,48 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"CreateVirtualGatewayOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualGateway"
|
||||
],
|
||||
"members": {
|
||||
"virtualGateway": {
|
||||
"shape": "VirtualGatewayData",
|
||||
"documentation": "<p>The full description of your virtual gateway following the create call.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "virtualGateway"
|
||||
},
|
||||
"ListVirtualGatewaysOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualGateways"
|
||||
],
|
||||
"members": {
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value to include in a future <code>ListVirtualGateways</code>\n request. When the results of a <code>ListVirtualGateways</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n value is <code>null</code> when there are no more results to return.</p>"
|
||||
},
|
||||
"virtualGateways": {
|
||||
"shape": "VirtualGatewayList",
|
||||
"documentation": "<p>The list of existing virtual gateways for the specified service mesh.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"VirtualGatewayTlsValidationContext": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"trust"
|
||||
],
|
||||
"members": {
|
||||
"trust": {
|
||||
"shape": "VirtualGatewayTlsValidationContextTrust",
|
||||
"documentation": "<p>A reference to an object that represents a TLS validation context trust.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) validation context.</p>"
|
||||
},
|
||||
"VirtualServiceProvider": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2412,6 +3435,88 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a route specification. Specify one route type.</p>"
|
||||
},
|
||||
"GatewayRouteRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"createdAt",
|
||||
"gatewayRouteName",
|
||||
"lastUpdatedAt",
|
||||
"meshName",
|
||||
"meshOwner",
|
||||
"resourceOwner",
|
||||
"version",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the gateway route.</p>"
|
||||
},
|
||||
"createdAt": {
|
||||
"shape": "Timestamp",
|
||||
"documentation": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
|
||||
},
|
||||
"gatewayRouteName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the gateway route.</p>"
|
||||
},
|
||||
"lastUpdatedAt": {
|
||||
"shape": "Timestamp",
|
||||
"documentation": "<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the resource resides in. </p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
|
||||
},
|
||||
"version": {
|
||||
"shape": "Long",
|
||||
"documentation": "<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The virtual gateway that the gateway route is associated with.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a gateway route returned by a list operation.</p>"
|
||||
},
|
||||
"VirtualGatewayListenerTlsAcmCertificate": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificateArn"
|
||||
],
|
||||
"members": {
|
||||
"certificateArn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/tls.html#virtual-node-tls-prerequisites\">Transport Layer Security (TLS)</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents an AWS Certicate Manager (ACM) certificate.</p>"
|
||||
},
|
||||
"ListGatewayRoutesOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRoutes"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRoutes": {
|
||||
"shape": "GatewayRouteList",
|
||||
"documentation": "<p>The list of existing gateway routes for the specified service mesh and virtual\n gateway.</p>"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value to include in a future <code>ListGatewayRoutes</code>\n request. When the results of a <code>ListGatewayRoutes</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n value is <code>null</code> when there are no more results to return.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateVirtualServiceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2461,7 +3566,8 @@
|
|||
"perRequest": {
|
||||
"shape": "Duration"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
},
|
||||
"DeleteVirtualServiceInput": {
|
||||
"type": "structure",
|
||||
|
|
@ -2504,6 +3610,14 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) validation context.</p>"
|
||||
},
|
||||
"GatewayRouteStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"DELETED",
|
||||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"DeleteVirtualRouterOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2518,12 +3632,52 @@
|
|||
"documentation": "",
|
||||
"payload": "virtualRouter"
|
||||
},
|
||||
"DescribeVirtualGatewayInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the gateway route resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway to describe.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TagsLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 50
|
||||
},
|
||||
"GrpcGatewayRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"target"
|
||||
],
|
||||
"members": {
|
||||
"target": {
|
||||
"shape": "GatewayRouteTarget",
|
||||
"documentation": "<p>An object that represents the target that traffic is routed to when a request matches the gateway route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"DeleteVirtualNodeOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2698,6 +3852,29 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"HttpGatewayRouteAction": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"target"
|
||||
],
|
||||
"members": {
|
||||
"target": {
|
||||
"shape": "GatewayRouteTarget",
|
||||
"documentation": "<p>An object that represents the target that traffic is routed to when a request matches the gateway route.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"GrpcGatewayRouteMatch": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"serviceName": {
|
||||
"shape": "ServiceName",
|
||||
"documentation": "<p>The fully qualified domain name for the service to match from the request.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
},
|
||||
"ListTagsForResourceInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2733,6 +3910,14 @@
|
|||
"min": 1,
|
||||
"max": 5
|
||||
},
|
||||
"VirtualGatewayStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"ACTIVE",
|
||||
"DELETED",
|
||||
"INACTIVE"
|
||||
]
|
||||
},
|
||||
"ServiceUnavailableException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -2790,6 +3975,19 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"UpdateGatewayRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRoute"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRoute": {
|
||||
"shape": "GatewayRouteData",
|
||||
"documentation": "<p>A full description of the gateway route that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "gatewayRoute"
|
||||
},
|
||||
"DescribeRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -2862,6 +4060,25 @@
|
|||
"tcp"
|
||||
]
|
||||
},
|
||||
"DeleteGatewayRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRoute"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRoute": {
|
||||
"shape": "GatewayRouteData",
|
||||
"documentation": "<p>The gateway route that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "gatewayRoute"
|
||||
},
|
||||
"VirtualGatewayList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "VirtualGatewayRef"
|
||||
}
|
||||
},
|
||||
"VirtualNodeStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
|
|
@ -3050,12 +4267,15 @@
|
|||
"type": "structure",
|
||||
"members": {
|
||||
"idle": {
|
||||
"shape": "Duration"
|
||||
"shape": "Duration",
|
||||
"documentation": "<p>An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.</p>"
|
||||
},
|
||||
"perRequest": {
|
||||
"shape": "Duration"
|
||||
"shape": "Duration",
|
||||
"documentation": "<p>An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
},
|
||||
"VirtualNodeStatus": {
|
||||
"type": "structure",
|
||||
|
|
@ -3272,6 +4492,19 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"VirtualGatewayTlsValidationContextFileTrust": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificateChain"
|
||||
],
|
||||
"members": {
|
||||
"certificateChain": {
|
||||
"shape": "FilePath",
|
||||
"documentation": "<p>The certificate trust chain for a certificate stored on the file system of the virtual\n node that the proxy is running on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) validation context trust for a local file.</p>"
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -3378,6 +4611,14 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the AWS Cloud Map attribute information for your virtual\n node.</p>"
|
||||
},
|
||||
"VirtualGatewayListenerTlsMode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"DISABLED",
|
||||
"PERMISSIVE",
|
||||
"STRICT"
|
||||
]
|
||||
},
|
||||
"VirtualServiceSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -3388,6 +4629,29 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the specification of a virtual service.</p>"
|
||||
},
|
||||
"VirtualGatewayTlsValidationContextAcmTrust": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"certificateAuthorityArns"
|
||||
],
|
||||
"members": {
|
||||
"certificateAuthorityArns": {
|
||||
"shape": "VirtualGatewayCertificateAuthorityArns",
|
||||
"documentation": "<p>One or more ACM Amazon Resource Name (ARN)s.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a TLS validation context trust for an AWS Certicate Manager (ACM)\n certificate.</p>"
|
||||
},
|
||||
"VirtualGatewayAccessLog": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"file": {
|
||||
"shape": "VirtualGatewayFileAccessLog",
|
||||
"documentation": "<p>The file object to send virtual gateway access logs to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>The access log configuration for a virtual gateway.</p>"
|
||||
},
|
||||
"MatchRange": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3438,7 +4702,8 @@
|
|||
"documentation": "<p>The action to take if a match is determined.</p>"
|
||||
},
|
||||
"timeout": {
|
||||
"shape": "TcpTimeout"
|
||||
"shape": "TcpTimeout",
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a TCP route type.</p>"
|
||||
|
|
@ -3449,6 +4714,19 @@
|
|||
"shape": "VirtualNodeRef"
|
||||
}
|
||||
},
|
||||
"UpdateVirtualGatewayOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualGateway"
|
||||
],
|
||||
"members": {
|
||||
"virtualGateway": {
|
||||
"shape": "VirtualGatewayData",
|
||||
"documentation": "<p>A full description of the virtual gateway that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "virtualGateway"
|
||||
},
|
||||
"ListVirtualRoutersInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3571,6 +4849,16 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualGatewayClientPolicy": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"tls": {
|
||||
"shape": "VirtualGatewayClientPolicyTls",
|
||||
"documentation": "<p>A reference to an object that represents a Transport Layer Security (TLS) client policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a client policy.</p>"
|
||||
},
|
||||
"ListVirtualNodesLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
|
|
@ -3606,6 +4894,16 @@
|
|||
"Timestamp": {
|
||||
"type": "timestamp"
|
||||
},
|
||||
"VirtualGatewayLogging": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"accessLog": {
|
||||
"shape": "VirtualGatewayAccessLog",
|
||||
"documentation": "<p>The access log configuration.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents logging information.</p>"
|
||||
},
|
||||
"HeaderMatch": {
|
||||
"type": "string",
|
||||
"min": 1,
|
||||
|
|
@ -3616,6 +4914,19 @@
|
|||
"min": 12,
|
||||
"max": 12
|
||||
},
|
||||
"GatewayRouteTarget": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualService"
|
||||
],
|
||||
"members": {
|
||||
"virtualService": {
|
||||
"shape": "GatewayRouteVirtualService",
|
||||
"documentation": "<p>An object that represents a virtual service gateway route target.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a gateway route target.</p>"
|
||||
},
|
||||
"Duration": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -3729,6 +5040,12 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a service mesh returned by a list operation.</p>"
|
||||
},
|
||||
"ListVirtualGatewaysLimit": {
|
||||
"type": "integer",
|
||||
"box": true,
|
||||
"min": 1,
|
||||
"max": 100
|
||||
},
|
||||
"MeshStatusCode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
|
|
@ -3765,6 +5082,25 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a service mesh returned by a describe operation.</p>"
|
||||
},
|
||||
"CreateGatewayRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRoute"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRoute": {
|
||||
"shape": "GatewayRouteData",
|
||||
"documentation": "<p>The full description of your gateway route following the create call.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "gatewayRoute"
|
||||
},
|
||||
"GatewayRouteList": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "GatewayRouteRef"
|
||||
}
|
||||
},
|
||||
"VirtualRouterStatus": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3791,6 +5127,33 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"DeleteVirtualGatewayInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to delete the virtual gateway from.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway to delete.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeVirtualNodeInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3847,7 +5210,8 @@
|
|||
"documentation": "<p>The port mapping information for the listener.</p>"
|
||||
},
|
||||
"timeout": {
|
||||
"shape": "ListenerTimeout"
|
||||
"shape": "ListenerTimeout",
|
||||
"documentation": "<p>An object that represents timeouts for different protocols.</p>"
|
||||
},
|
||||
"tls": {
|
||||
"shape": "ListenerTls",
|
||||
|
|
@ -3876,7 +5240,8 @@
|
|||
"documentation": "<p>An object that represents a retry policy.</p>"
|
||||
},
|
||||
"timeout": {
|
||||
"shape": "GrpcTimeout"
|
||||
"shape": "GrpcTimeout",
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a gRPC route type.</p>"
|
||||
|
|
@ -3909,6 +5274,20 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) client policy.</p>"
|
||||
},
|
||||
"VirtualGatewayTlsValidationContextTrust": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
"acm": {
|
||||
"shape": "VirtualGatewayTlsValidationContextAcmTrust",
|
||||
"documentation": "<p>A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM)\n certificate.</p>"
|
||||
},
|
||||
"file": {
|
||||
"shape": "VirtualGatewayTlsValidationContextFileTrust",
|
||||
"documentation": "<p>An object that represents a TLS validation context trust for a local file.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a Transport Layer Security (TLS) validation context trust.</p>"
|
||||
},
|
||||
"DeleteVirtualServiceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3923,6 +5302,14 @@
|
|||
"documentation": "",
|
||||
"payload": "virtualService"
|
||||
},
|
||||
"VirtualGatewayPortProtocol": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"grpc",
|
||||
"http",
|
||||
"http2"
|
||||
]
|
||||
},
|
||||
"VirtualNodeServiceProvider": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -3936,6 +5323,24 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents a virtual node service provider.</p>"
|
||||
},
|
||||
"HttpGatewayRoute": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"action",
|
||||
"match"
|
||||
],
|
||||
"members": {
|
||||
"action": {
|
||||
"shape": "HttpGatewayRouteAction",
|
||||
"documentation": "<p>An object that represents the action to take if a match is determined.</p>"
|
||||
},
|
||||
"match": {
|
||||
"shape": "HttpGatewayRouteMatch",
|
||||
"documentation": "<p>An object that represents the criteria for determining a request match.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents an HTTP gateway route.</p>"
|
||||
},
|
||||
"BackendDefaults": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -4044,6 +5449,82 @@
|
|||
"senderFault": true
|
||||
}
|
||||
},
|
||||
"UpdateGatewayRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRouteName",
|
||||
"meshName",
|
||||
"spec",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"clientToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"idempotencyToken": true
|
||||
},
|
||||
"gatewayRouteName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the gateway route to update.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "gatewayRouteName"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the gateway route resides in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"spec": {
|
||||
"shape": "GatewayRouteSpec",
|
||||
"documentation": "<p>The new gateway route specification to apply. This overwrites the existing data.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway that the gateway route is associated with.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListVirtualGatewaysInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"meshName"
|
||||
],
|
||||
"members": {
|
||||
"limit": {
|
||||
"shape": "ListVirtualGatewaysLimit",
|
||||
"documentation": "<p>The maximum number of results returned by <code>ListVirtualGateways</code> in paginated\n output. When you use this parameter, <code>ListVirtualGateways</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualGateways</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualGateways</code> returns up to 100 results and\n a <code>nextToken</code> value if applicable.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "limit"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to list virtual gateways in.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"nextToken": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualGateways</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "nextToken"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PortNumber": {
|
||||
"type": "integer",
|
||||
"min": 1,
|
||||
|
|
@ -4133,6 +5614,14 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualGatewayCertificateAuthorityArns": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
"shape": "Arn"
|
||||
},
|
||||
"min": 1,
|
||||
"max": 3
|
||||
},
|
||||
"WeightedTargets": {
|
||||
"type": "list",
|
||||
"member": {
|
||||
|
|
@ -4158,7 +5647,8 @@
|
|||
"idle": {
|
||||
"shape": "Duration"
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
},
|
||||
"HttpScheme": {
|
||||
"type": "string",
|
||||
|
|
@ -4167,6 +5657,40 @@
|
|||
"https"
|
||||
]
|
||||
},
|
||||
"DeleteGatewayRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRouteName",
|
||||
"meshName",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRouteName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the gateway route to delete.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "gatewayRouteName"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh to delete the gateway route from.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "meshName"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>",
|
||||
"location": "querystring",
|
||||
"locationName": "meshOwner"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the virtual gateway to delete the route from.</p>",
|
||||
"location": "uri",
|
||||
"locationName": "virtualGatewayName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateRouteInput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
@ -4232,7 +5756,8 @@
|
|||
"documentation": "<p>An object that represents a retry policy.</p>"
|
||||
},
|
||||
"timeout": {
|
||||
"shape": "HttpTimeout"
|
||||
"shape": "HttpTimeout",
|
||||
"documentation": "<p>An object that represents types of timeouts. </p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents an HTTP or HTTP/2 route type.</p>"
|
||||
|
|
@ -4258,6 +5783,54 @@
|
|||
},
|
||||
"documentation": ""
|
||||
},
|
||||
"VirtualGatewayRef": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"arn",
|
||||
"createdAt",
|
||||
"lastUpdatedAt",
|
||||
"meshName",
|
||||
"meshOwner",
|
||||
"resourceOwner",
|
||||
"version",
|
||||
"virtualGatewayName"
|
||||
],
|
||||
"members": {
|
||||
"arn": {
|
||||
"shape": "Arn",
|
||||
"documentation": "<p>The full Amazon Resource Name (ARN) for the resource.</p>"
|
||||
},
|
||||
"createdAt": {
|
||||
"shape": "Timestamp",
|
||||
"documentation": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>"
|
||||
},
|
||||
"lastUpdatedAt": {
|
||||
"shape": "Timestamp",
|
||||
"documentation": "<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>"
|
||||
},
|
||||
"meshName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the service mesh that the resource resides in.</p>"
|
||||
},
|
||||
"meshOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
|
||||
},
|
||||
"resourceOwner": {
|
||||
"shape": "AccountId",
|
||||
"documentation": "<p>The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html\">Working with shared meshes</a>.</p>"
|
||||
},
|
||||
"version": {
|
||||
"shape": "Long",
|
||||
"documentation": "<p>The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.</p>"
|
||||
},
|
||||
"virtualGatewayName": {
|
||||
"shape": "ResourceName",
|
||||
"documentation": "<p>The name of the resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation": "<p>An object that represents a virtual gateway returned by a list operation.</p>"
|
||||
},
|
||||
"MeshSpec": {
|
||||
"type": "structure",
|
||||
"members": {
|
||||
|
|
@ -4268,6 +5841,32 @@
|
|||
},
|
||||
"documentation": "<p>An object that represents the specification of a service mesh.</p>"
|
||||
},
|
||||
"DescribeVirtualGatewayOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"virtualGateway"
|
||||
],
|
||||
"members": {
|
||||
"virtualGateway": {
|
||||
"shape": "VirtualGatewayData",
|
||||
"documentation": "<p>The full description of your virtual gateway.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "virtualGateway"
|
||||
},
|
||||
"DescribeGatewayRouteOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
"gatewayRoute"
|
||||
],
|
||||
"members": {
|
||||
"gatewayRoute": {
|
||||
"shape": "GatewayRouteData",
|
||||
"documentation": "<p>The full description of your gateway route.</p>"
|
||||
}
|
||||
},
|
||||
"payload": "gatewayRoute"
|
||||
},
|
||||
"ListTagsForResourceOutput": {
|
||||
"type": "structure",
|
||||
"required": [
|
||||
|
|
|
|||
|
|
@ -754,7 +754,7 @@
|
|||
},
|
||||
"type":{
|
||||
"shape":"ApiCacheType",
|
||||
"documentation":"<p>The cache instance type.</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>"
|
||||
"documentation":"<p>The cache instance type. Valid values are </p> <ul> <li> <p> <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p> <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p> <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li> <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p> <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.</p> <p>The following legacy instance types are avaible, but their use is discouraged:</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"ApiCacheStatus",
|
||||
|
|
@ -782,7 +782,15 @@
|
|||
"R4_XLARGE",
|
||||
"R4_2XLARGE",
|
||||
"R4_4XLARGE",
|
||||
"R4_8XLARGE"
|
||||
"R4_8XLARGE",
|
||||
"SMALL",
|
||||
"MEDIUM",
|
||||
"LARGE",
|
||||
"XLARGE",
|
||||
"LARGE_2X",
|
||||
"LARGE_4X",
|
||||
"LARGE_8X",
|
||||
"LARGE_12X"
|
||||
]
|
||||
},
|
||||
"ApiCachingBehavior":{
|
||||
|
|
@ -993,7 +1001,7 @@
|
|||
},
|
||||
"type":{
|
||||
"shape":"ApiCacheType",
|
||||
"documentation":"<p>The cache instance type.</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>"
|
||||
"documentation":"<p>The cache instance type. Valid values are </p> <ul> <li> <p> <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p> <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p> <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li> <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p> <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.</p> <p>The following legacy instance types are avaible, but their use is discouraged:</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <code>CreateApiCache</code> operation.</p>"
|
||||
|
|
@ -2436,7 +2444,7 @@
|
|||
},
|
||||
"dbClusterIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Amazon RDS cluster identifier.</p>"
|
||||
"documentation":"<p>Amazon RDS cluster ARN.</p>"
|
||||
},
|
||||
"databaseName":{
|
||||
"shape":"String",
|
||||
|
|
@ -2745,7 +2753,7 @@
|
|||
},
|
||||
"type":{
|
||||
"shape":"ApiCacheType",
|
||||
"documentation":"<p>The cache instance type.</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>"
|
||||
"documentation":"<p>The cache instance type. Valid values are </p> <ul> <li> <p> <code>SMALL</code> </p> </li> <li> <p> <code>MEDIUM</code> </p> </li> <li> <p> <code>LARGE</code> </p> </li> <li> <p> <code>XLARGE</code> </p> </li> <li> <p> <code>LARGE_2X</code> </p> </li> <li> <p> <code>LARGE_4X</code> </p> </li> <li> <p> <code>LARGE_8X</code> (not available in all regions)</p> </li> <li> <p> <code>LARGE_12X</code> </p> </li> </ul> <p>Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.</p> <p>The following legacy instance types are avaible, but their use is discouraged:</p> <ul> <li> <p> <b>T2_SMALL</b>: A t2.small instance type.</p> </li> <li> <p> <b>T2_MEDIUM</b>: A t2.medium instance type.</p> </li> <li> <p> <b>R4_LARGE</b>: A r4.large instance type.</p> </li> <li> <p> <b>R4_XLARGE</b>: A r4.xlarge instance type.</p> </li> <li> <p> <b>R4_2XLARGE</b>: A r4.2xlarge instance type.</p> </li> <li> <p> <b>R4_4XLARGE</b>: A r4.4xlarge instance type.</p> </li> <li> <p> <b>R4_8XLARGE</b>: A r4.8xlarge instance type.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <code>UpdateApiCache</code> operation.</p>"
|
||||
|
|
|
|||
|
|
@ -139,7 +139,7 @@
|
|||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
],
|
||||
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the <a>DescribeAccountLimits</a> API. For information about updating this limit, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Service Quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For introductory exercises for creating an Auto Scaling group, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html\">Getting Started with Amazon EC2 Auto Scaling</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html\">Tutorial: Set Up a Scaled and Load-Balanced Application</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates an Auto Scaling group with the specified name and attributes. </p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the <a>DescribeAccountLimits</a> API. For information about updating this limit, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html\">Amazon EC2 Auto Scaling Service Quotas</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For introductory exercises for creating an Auto Scaling group, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/GettingStartedTutorial.html\">Getting Started with Amazon EC2 Auto Scaling</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-register-lbs-with-asg.html\">Tutorial: Set Up a Scaled and Load-Balanced Application</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"CreateLaunchConfiguration":{
|
||||
"name":"CreateLaunchConfiguration",
|
||||
|
|
@ -357,7 +357,7 @@
|
|||
{"shape":"InvalidNextToken"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Describes one or more instance refreshes.</p> <p>You can determine the status of a request by looking at the <code>Status</code> parameter. The following are the possible statuses: </p> <ul> <li> <p> <code>Pending</code> - The request was created, but the operation has not started.</p> </li> <li> <p> <code>InProgress</code> - The operation is in progress.</p> </li> <li> <p> <code>Successful</code> - The operation completed successfully.</p> </li> <li> <p> <code>Failed</code> - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities. </p> </li> <li> <p> <code>Cancelling</code> - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. </p> </li> <li> <p> <code>Cancelled</code> - The operation is cancelled. </p> </li> </ul>"
|
||||
"documentation":"<p>Describes one or more instance refreshes.</p> <p>You can determine the status of a request by looking at the <code>Status</code> parameter. The following are the possible statuses: </p> <ul> <li> <p> <code>Pending</code> - The request was created, but the operation has not started.</p> </li> <li> <p> <code>InProgress</code> - The operation is in progress.</p> </li> <li> <p> <code>Successful</code> - The operation completed successfully.</p> </li> <li> <p> <code>Failed</code> - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities. </p> </li> <li> <p> <code>Cancelling</code> - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. </p> </li> <li> <p> <code>Cancelled</code> - The operation is cancelled. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling Instances Based on an Instance Refresh</a>.</p>"
|
||||
},
|
||||
"DescribeLaunchConfigurations":{
|
||||
"name":"DescribeLaunchConfigurations",
|
||||
|
|
@ -669,7 +669,7 @@
|
|||
{"shape":"ScalingActivityInProgressFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Executes the specified policy.</p>"
|
||||
"documentation":"<p>Executes the specified policy. This can be useful for testing the design of your scaling policy.</p>"
|
||||
},
|
||||
"ExitStandby":{
|
||||
"name":"ExitStandby",
|
||||
|
|
@ -837,7 +837,7 @@
|
|||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"InstanceRefreshInProgressFault"}
|
||||
],
|
||||
"documentation":"<p>Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.</p> <p>If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an active instance refresh operation, use the <a>CancelInstanceRefresh</a> API.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling Instances Based on an Instance Refresh</a>.</p>"
|
||||
"documentation":"<p>Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.</p> <p>If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an instance refresh operation in progress, use the <a>CancelInstanceRefresh</a> API. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling Instances Based on an Instance Refresh</a>.</p>"
|
||||
},
|
||||
"SuspendProcesses":{
|
||||
"name":"SuspendProcesses",
|
||||
|
|
@ -1142,7 +1142,7 @@
|
|||
},
|
||||
"DefaultCooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.</p>"
|
||||
"documentation":"<p>The duration of the default cooldown period, in seconds.</p>"
|
||||
},
|
||||
"AvailabilityZones":{
|
||||
"shape":"AvailabilityZones",
|
||||
|
|
@ -1534,7 +1534,7 @@
|
|||
},
|
||||
"DefaultCooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is <code>300</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is <code>300</code>.</p> <p>This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"AvailabilityZones":{
|
||||
"shape":"AvailabilityZones",
|
||||
|
|
@ -1554,7 +1554,7 @@
|
|||
},
|
||||
"HealthCheckGracePeriod":{
|
||||
"shape":"HealthCheckGracePeriod",
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health Check Grace Period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you are adding an <code>ELB</code> health check.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health Check Grace Period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Required if you are adding an <code>ELB</code> health check.</p>"
|
||||
},
|
||||
"PlacementGroup":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -1864,7 +1864,7 @@
|
|||
"members":{
|
||||
"InstanceRefreshes":{
|
||||
"shape":"InstanceRefreshes",
|
||||
"documentation":"<p>The instance refreshes for the specified group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling Instances Based on an Instance Refresh</a>.</p>"
|
||||
"documentation":"<p>The instance refreshes for the specified group.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"XmlString",
|
||||
|
|
@ -2227,11 +2227,11 @@
|
|||
"members":{
|
||||
"SnapshotId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The snapshot ID of the volume to use.</p> <p>Conditional: This parameter is optional if you specify a volume size. If you specify both <code>SnapshotId</code> and <code>VolumeSize</code>, <code>VolumeSize</code> must be equal or greater than the size of the snapshot.</p>"
|
||||
"documentation":"<p>The snapshot ID of the volume to use.</p> <p>You must specify either a <code>VolumeSize</code> or a <code>SnapshotId</code>.</p>"
|
||||
},
|
||||
"VolumeSize":{
|
||||
"shape":"BlockDeviceEbsVolumeSize",
|
||||
"documentation":"<p>The volume size, in Gibibytes (GiB).</p> <p>This can be a number from 1-1,024 for <code>standard</code>, 4-16,384 for <code>io1</code>, 1-16,384 for <code>gp2</code>, and 500-16,384 for <code>st1</code> and <code>sc1</code>. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.</p> <p>Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.</p> <note> <p>At least one of VolumeSize or SnapshotId is required.</p> </note>"
|
||||
"documentation":"<p>The volume size, in Gibibytes (GiB).</p> <p>This can be a number from 1-1,024 for <code>standard</code>, 4-16,384 for <code>io1</code>, 1-16,384 for <code>gp2</code>, and 500-16,384 for <code>st1</code> and <code>sc1</code>. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.</p> <p>Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.</p> <p>You must specify either a <code>VolumeSize</code> or a <code>SnapshotId</code>. If you specify both <code>SnapshotId</code> and <code>VolumeSize</code>, the volume size must be equal or greater than the size of the snapshot.</p>"
|
||||
},
|
||||
"VolumeType":{
|
||||
"shape":"BlockDeviceEbsVolumeType",
|
||||
|
|
@ -2243,7 +2243,7 @@
|
|||
},
|
||||
"Iops":{
|
||||
"shape":"BlockDeviceEbsIops",
|
||||
"documentation":"<p>The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS Volume Types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>Conditional: This parameter is required when the volume type is <code>io1</code>. (Not used with <code>standard</code>, <code>gp2</code>, <code>st1</code>, or <code>sc1</code> volumes.) </p>"
|
||||
"documentation":"<p>The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\">Amazon EBS Volume Types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>Required when the volume type is <code>io1</code>. (Not used with <code>standard</code>, <code>gp2</code>, <code>st1</code>, or <code>sc1</code> volumes.) </p>"
|
||||
},
|
||||
"Encrypted":{
|
||||
"shape":"BlockDeviceEbsEncrypted",
|
||||
|
|
@ -2337,15 +2337,15 @@
|
|||
},
|
||||
"HonorCooldown":{
|
||||
"shape":"HonorCooldown",
|
||||
"documentation":"<p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.</p> <p>This parameter is not supported if the policy type is <code>StepScaling</code> or <code>TargetTrackingScaling</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.</p> <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"MetricValue":{
|
||||
"shape":"MetricScale",
|
||||
"documentation":"<p>The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.</p> <p>If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.</p> <p>Conditional: This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
|
||||
"documentation":"<p>The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.</p> <p>If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.</p> <p>Required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
|
||||
},
|
||||
"BreachThreshold":{
|
||||
"shape":"MetricScale",
|
||||
"documentation":"<p>The breach threshold for the alarm.</p> <p>Conditional: This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
|
||||
"documentation":"<p>The breach threshold for the alarm.</p> <p>Required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3072,14 +3072,14 @@
|
|||
"members":{
|
||||
"LaunchTemplate":{
|
||||
"shape":"LaunchTemplate",
|
||||
"documentation":"<p>The launch template and instance types (overrides).</p> <p>This parameter must be specified when creating a mixed instances policy.</p>"
|
||||
"documentation":"<p>The launch template and instance types (overrides).</p> <p>Required when creating a mixed instances policy.</p>"
|
||||
},
|
||||
"InstancesDistribution":{
|
||||
"shape":"InstancesDistribution",
|
||||
"documentation":"<p>The instances distribution to use.</p> <p>If you leave this parameter unspecified, the value for each parameter in <code>InstancesDistribution</code> uses a default value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify <code>MixedInstancesPolicy</code> as the top-level parameter instead of a launch configuration or template. For more information, see <a>CreateAutoScalingGroup</a> and <a>UpdateAutoScalingGroup</a>.</p>"
|
||||
"documentation":"<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling Groups with Multiple Instance Types and Purchase Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify <code>MixedInstancesPolicy</code> as the top-level parameter instead of a launch configuration or launch template. For more information, see <a>CreateAutoScalingGroup</a> and <a>UpdateAutoScalingGroup</a>.</p>"
|
||||
},
|
||||
"MonitoringEnabled":{"type":"boolean"},
|
||||
"NoDevice":{"type":"boolean"},
|
||||
|
|
@ -3223,11 +3223,11 @@
|
|||
},
|
||||
"LifecycleTransition":{
|
||||
"shape":"LifecycleTransition",
|
||||
"documentation":"<p>The instance state to which you want to attach the lifecycle hook. The valid values are:</p> <ul> <li> <p>autoscaling:EC2_INSTANCE_LAUNCHING</p> </li> <li> <p>autoscaling:EC2_INSTANCE_TERMINATING</p> </li> </ul> <p>Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>"
|
||||
"documentation":"<p>The instance state to which you want to attach the lifecycle hook. The valid values are:</p> <ul> <li> <p>autoscaling:EC2_INSTANCE_LAUNCHING</p> </li> <li> <p>autoscaling:EC2_INSTANCE_TERMINATING</p> </li> </ul> <p>Required for new lifecycle hooks, but optional when updating existing hooks.</p>"
|
||||
},
|
||||
"RoleARN":{
|
||||
"shape":"ResourceName",
|
||||
"documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.</p> <p>Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>"
|
||||
"documentation":"<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.</p> <p>Required for new lifecycle hooks, but optional when updating existing hooks.</p>"
|
||||
},
|
||||
"NotificationTargetARN":{
|
||||
"shape":"NotificationTargetResourceName",
|
||||
|
|
@ -3286,11 +3286,11 @@
|
|||
},
|
||||
"PolicyType":{
|
||||
"shape":"XmlStringMaxLen64",
|
||||
"documentation":"<p>The policy type. The valid values are <code>SimpleScaling</code>, <code>StepScaling</code>, and <code>TargetTrackingScaling</code>. If the policy type is null, the value is treated as <code>SimpleScaling</code>.</p>"
|
||||
"documentation":"<p>One of the following policy types: </p> <ul> <li> <p> <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code> </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>"
|
||||
},
|
||||
"AdjustmentType":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>Specifies whether the <code>ScalingAdjustment</code> parameter is an absolute number or a percentage of the current capacity. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>Valid only if the policy type is <code>StepScaling</code> or <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment\">Scaling Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Specifies how the scaling adjustment is interpreted (either an absolute number or a percentage). The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p> <p>Required if the policy type is <code>StepScaling</code> or <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment\">Scaling Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"MinAdjustmentStep":{
|
||||
"shape":"MinAdjustmentStep",
|
||||
|
|
@ -3298,15 +3298,15 @@
|
|||
},
|
||||
"MinAdjustmentMagnitude":{
|
||||
"shape":"MinAdjustmentMagnitude",
|
||||
"documentation":"<p>The minimum value to scale by when scaling by percentages. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a <code>MinAdjustmentMagnitude</code> of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances. </p> <p>Valid only if the policy type is <code>StepScaling</code> or <code>SimpleScaling</code> and the adjustment type is <code>PercentChangeInCapacity</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment\">Scaling Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The minimum value to scale by when the adjustment type is <code>PercentChangeInCapacity</code>. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a <code>MinAdjustmentMagnitude</code> of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.</p> <p>Valid only if the policy type is <code>StepScaling</code> or <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment\">Scaling Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <note> <p>Some Auto Scaling groups use instance weights. In this case, set the <code>MinAdjustmentMagnitude</code> to a value that is at least as large as your largest instance weight.</p> </note>"
|
||||
},
|
||||
"ScalingAdjustment":{
|
||||
"shape":"PolicyIncrement",
|
||||
"documentation":"<p>The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the <code>AdjustmentType</code> parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.</p> <p>Conditional: If you specify <code>SimpleScaling</code> for the policy type, you must specify this parameter. (Not used with any other policy type.) </p>"
|
||||
"documentation":"<p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value.</p> <p>Required if the policy type is <code>SimpleScaling</code>. (Not used with any other policy type.) </p>"
|
||||
},
|
||||
"Cooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The duration of the policy's cooldown period, in seconds. When a cooldown period is specified here, it overrides the default cooldown period defined for the Auto Scaling group.</p> <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"MetricAggregationType":{
|
||||
"shape":"XmlStringMaxLen32",
|
||||
|
|
@ -3314,15 +3314,15 @@
|
|||
},
|
||||
"StepAdjustments":{
|
||||
"shape":"StepAdjustments",
|
||||
"documentation":"<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p> <p>Conditional: If you specify <code>StepScaling</code> for the policy type, you must specify this parameter. (Not used with any other policy type.) </p>"
|
||||
"documentation":"<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not used with any other policy type.) </p>"
|
||||
},
|
||||
"EstimatedInstanceWarmup":{
|
||||
"shape":"EstimatedInstanceWarmup",
|
||||
"documentation":"<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.</p> <p>Valid only if the policy type is <code>StepScaling</code> or <code>TargetTrackingScaling</code>.</p>"
|
||||
"documentation":"<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. If not provided, the default is to use the value from the default cooldown period for the Auto Scaling group.</p> <p>Valid only if the policy type is <code>TargetTrackingScaling</code> or <code>StepScaling</code>.</p>"
|
||||
},
|
||||
"TargetTrackingConfiguration":{
|
||||
"shape":"TargetTrackingConfiguration",
|
||||
"documentation":"<p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html\">TargetTrackingConfiguration</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Conditional: If you specify <code>TargetTrackingScaling</code> for the policy type, you must specify this parameter. (Not used with any other policy type.) </p>"
|
||||
"documentation":"<p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> </p> </li> <li> <p> <code>ASGAverageNetworkIn</code> </p> </li> <li> <p> <code>ASGAverageNetworkOut</code> </p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> </p> </li> </ul> <p>If you specify <code>ALBRequestCountPerTarget</code> for the metric, you must specify the <code>ResourceLabel</code> parameter with the <code>PredefinedMetricSpecification</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html\">TargetTrackingConfiguration</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Required if the policy type is <code>TargetTrackingScaling</code>.</p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"ScalingPolicyEnabled",
|
||||
|
|
@ -3418,7 +3418,7 @@
|
|||
},
|
||||
"InstanceWarmup":{
|
||||
"shape":"RefreshInstanceWarmup",
|
||||
"documentation":"<p>The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value specified for the health check grace period for the group.</p> <p>Note: While warming up, a newly launched instance is not counted toward the aggregated metrics of the Auto Scaling group. </p>"
|
||||
"documentation":"<p>The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes information used to start an instance refresh. </p>"
|
||||
|
|
@ -3519,11 +3519,11 @@
|
|||
},
|
||||
"PolicyType":{
|
||||
"shape":"XmlStringMaxLen64",
|
||||
"documentation":"<p>The policy type. The valid values are <code>SimpleScaling</code>, <code>StepScaling</code>, and <code>TargetTrackingScaling</code>.</p>"
|
||||
"documentation":"<p>One of the following policy types: </p> <ul> <li> <p> <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code> </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html\">Target Tracking Scaling Policies</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html\">Step and Simple Scaling Policies</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"AdjustmentType":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The adjustment type, which specifies how <code>ScalingAdjustment</code> is interpreted. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>"
|
||||
"documentation":"<p>Specifies how the scaling adjustment is interpreted (either an absolute number or a percentage). The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>"
|
||||
},
|
||||
"MinAdjustmentStep":{
|
||||
"shape":"MinAdjustmentStep",
|
||||
|
|
@ -3531,7 +3531,7 @@
|
|||
},
|
||||
"MinAdjustmentMagnitude":{
|
||||
"shape":"MinAdjustmentMagnitude",
|
||||
"documentation":"<p>The minimum number of instances to scale. If the value of <code>AdjustmentType</code> is <code>PercentChangeInCapacity</code>, the scaling policy changes the <code>DesiredCapacity</code> of the Auto Scaling group by at least this many instances. Otherwise, the error is <code>ValidationError</code>.</p>"
|
||||
"documentation":"<p>The minimum value to scale by when the adjustment type is <code>PercentChangeInCapacity</code>. </p>"
|
||||
},
|
||||
"ScalingAdjustment":{
|
||||
"shape":"PolicyIncrement",
|
||||
|
|
@ -3539,7 +3539,7 @@
|
|||
},
|
||||
"Cooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.</p>"
|
||||
"documentation":"<p>The duration of the policy's cooldown period, in seconds.</p>"
|
||||
},
|
||||
"StepAdjustments":{
|
||||
"shape":"StepAdjustments",
|
||||
|
|
@ -3802,11 +3802,11 @@
|
|||
},
|
||||
"Strategy":{
|
||||
"shape":"RefreshStrategy",
|
||||
"documentation":"<p>The strategy to use for the instance refresh. The only valid value is <code>Rolling</code>.</p> <p>A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale-in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration. </p>"
|
||||
"documentation":"<p>The strategy to use for the instance refresh. The only valid value is <code>Rolling</code>.</p> <p>A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration. </p>"
|
||||
},
|
||||
"Preferences":{
|
||||
"shape":"RefreshPreferences",
|
||||
"documentation":"<p>Set of preferences associated with the instance refresh request.</p>"
|
||||
"documentation":"<p>Set of preferences associated with the instance refresh request.</p> <p>If not provided, the default values are used. For <code>MinHealthyPercentage</code>, the default value is <code>90</code>. For <code>InstanceWarmup</code>, the default is to use the value specified for the health check grace period for the Auto Scaling group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_RefreshPreferences.html\">RefreshPreferences</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4020,7 +4020,7 @@
|
|||
},
|
||||
"DefaultCooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is <code>300</code>. This cooldown period is not used when a scaling-specific cooldown is specified.</p> <p>Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is <code>300</code>.</p> <p>This setting applies when using simple scaling policies, but not when using other scaling policies or scheduled scaling. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"AvailabilityZones":{
|
||||
"shape":"AvailabilityZones",
|
||||
|
|
@ -4032,7 +4032,7 @@
|
|||
},
|
||||
"HealthCheckGracePeriod":{
|
||||
"shape":"HealthCheckGracePeriod",
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health Check Grace Period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Conditional: This parameter is required if you are adding an <code>ELB</code> health check.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is <code>0</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html#health-check-grace-period\">Health Check Grace Period</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Required if you are adding an <code>ELB</code> health check.</p>"
|
||||
},
|
||||
"PlacementGroup":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
|
|||
|
|
@ -259,7 +259,7 @@
|
|||
"errors":[
|
||||
{"shape":"ServiceUnavailableException"}
|
||||
],
|
||||
"documentation":"<p>Returns the current service opt-in settings for the region. If the service has a value set to true, AWS Backup will attempt to protect that service's resources in this region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup will not attempt to protect that service's resources in this region.</p>"
|
||||
"documentation":"<p>Returns the current service opt-in settings for the Region. If the service has a value set to <code>true</code>, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to <code>false</code> for a service, AWS Backup does not attempt to protect that service's resources in this Region.</p>"
|
||||
},
|
||||
"DescribeRestoreJob":{
|
||||
"name":"DescribeRestoreJob",
|
||||
|
|
@ -435,7 +435,6 @@
|
|||
"output":{"shape":"ListBackupJobsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ServiceUnavailableException"}
|
||||
],
|
||||
"documentation":"<p>Returns metadata about your backup jobs.</p>",
|
||||
|
|
@ -802,11 +801,15 @@
|
|||
{"shape":"MissingParameterValueException"},
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
],
|
||||
"documentation":"<p>Updates the current service opt-in settings for the region. If the service has a value set to true, AWS Backup will attempt to protect that service's resources in this region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup will not attempt to protect that service's resources in this region.</p>"
|
||||
"documentation":"<p>Updates the current service opt-in settings for the Region. If the service has a value set to <code>true</code>, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to <code>false</code> for a service, AWS Backup does not attempt to protect that service's resources in this Region.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"ARN":{"type":"string"},
|
||||
"AccountId":{
|
||||
"type":"string",
|
||||
"pattern":"^[0-9]{12}$"
|
||||
},
|
||||
"AlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -835,6 +838,10 @@
|
|||
"BackupJob":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID that owns the backup job.</p>"
|
||||
},
|
||||
"BackupJobId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>"
|
||||
|
|
@ -950,7 +957,7 @@
|
|||
"members":{
|
||||
"BackupPlanName":{
|
||||
"shape":"BackupPlanName",
|
||||
"documentation":"<p>The display name of a backup plan.</p>"
|
||||
"documentation":"<p>The optional display name of a backup plan.</p>"
|
||||
},
|
||||
"Rules":{
|
||||
"shape":"BackupRulesInput",
|
||||
|
|
@ -1313,6 +1320,10 @@
|
|||
"CopyJob":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID that owns the copy job.</p>"
|
||||
},
|
||||
"CopyJobId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Uniquely identifies a copy job.</p>"
|
||||
|
|
@ -1339,11 +1350,11 @@
|
|||
},
|
||||
"CreationDate":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. </p>"
|
||||
"documentation":"<p>The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
},
|
||||
"CompletionDate":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. </p>"
|
||||
"documentation":"<p>The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
},
|
||||
"State":{
|
||||
"shape":"CopyJobState",
|
||||
|
|
@ -1528,7 +1539,7 @@
|
|||
},
|
||||
"DeletionDate":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
"documentation":"<p>The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
},
|
||||
"VersionId":{
|
||||
"shape":"string",
|
||||
|
|
@ -1647,6 +1658,10 @@
|
|||
"DescribeBackupJobOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>Returns the account ID that owns the backup job.</p>"
|
||||
},
|
||||
"BackupJobId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Uniquely identifies a request to AWS Backup to back up a resource.</p>"
|
||||
|
|
@ -1673,7 +1688,7 @@
|
|||
},
|
||||
"CompletionDate":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
"documentation":"<p>The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
},
|
||||
"State":{
|
||||
"shape":"BackupJobState",
|
||||
|
|
@ -1931,6 +1946,10 @@
|
|||
"DescribeRestoreJobOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>Returns the account ID that owns the restore job.</p>"
|
||||
},
|
||||
"RestoreJobId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Uniquely identifies the job that restores a recovery point.</p>"
|
||||
|
|
@ -1953,7 +1972,7 @@
|
|||
},
|
||||
"StatusMessage":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A detailed message explaining the status of a job to restore a recovery point.</p>"
|
||||
"documentation":"<p>A message showing the status of a job to restore a recovery point.</p>"
|
||||
},
|
||||
"PercentDone":{
|
||||
"shape":"string",
|
||||
|
|
@ -1974,6 +1993,10 @@
|
|||
"CreatedResourceArn":{
|
||||
"shape":"ARN",
|
||||
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.</p>"
|
||||
},
|
||||
"ResourceType":{
|
||||
"shape":"ResourceType",
|
||||
"documentation":"<p>Returns metadata associated with a restore job listed by resource type.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2085,7 +2108,7 @@
|
|||
},
|
||||
"DeletionDate":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
"documentation":"<p>The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
|
||||
},
|
||||
"LastExecutionDate":{
|
||||
"shape":"timestamp",
|
||||
|
|
@ -2244,7 +2267,7 @@
|
|||
"members":{
|
||||
"ResourceTypes":{
|
||||
"shape":"ResourceTypes",
|
||||
"documentation":"<p>Contains a string with the supported AWS resource types:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
|
||||
"documentation":"<p>Contains a string with the supported AWS resource types:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2363,9 +2386,15 @@
|
|||
},
|
||||
"ByResourceType":{
|
||||
"shape":"ResourceType",
|
||||
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
|
||||
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"resourceType"
|
||||
},
|
||||
"ByAccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"accountId"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2593,7 +2622,7 @@
|
|||
},
|
||||
"ByResourceType":{
|
||||
"shape":"ResourceType",
|
||||
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
|
||||
"documentation":"<p>Returns only backup jobs for the specified resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"resourceType"
|
||||
},
|
||||
|
|
@ -2602,6 +2631,12 @@
|
|||
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"destinationVaultArn"
|
||||
},
|
||||
"ByAccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"accountId"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2770,6 +2805,30 @@
|
|||
"documentation":"<p>The maximum number of items to be returned.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"ByAccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"accountId"
|
||||
},
|
||||
"ByCreatedBefore":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>Returns only restore jobs that were created before the specified date.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"createdBefore"
|
||||
},
|
||||
"ByCreatedAfter":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>Returns only restore jobs that were created after the specified date.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"createdAfter"
|
||||
},
|
||||
"ByStatus":{
|
||||
"shape":"RestoreJobStatus",
|
||||
"documentation":"<p>Returns only restore jobs associated with the specified job status.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"status"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3107,6 +3166,10 @@
|
|||
"RestoreJobsListMember":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AccountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The account ID that owns the restore job.</p>"
|
||||
},
|
||||
"RestoreJobId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Uniquely identifies the job that restores a recovery point.</p>"
|
||||
|
|
@ -3150,6 +3213,10 @@
|
|||
"CreatedResourceArn":{
|
||||
"shape":"ARN",
|
||||
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.</p>"
|
||||
},
|
||||
"ResourceType":{
|
||||
"shape":"ResourceType",
|
||||
"documentation":"<p>The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains metadata about a restore job.</p>"
|
||||
|
|
@ -3302,7 +3369,7 @@
|
|||
},
|
||||
"ResourceType":{
|
||||
"shape":"ResourceType",
|
||||
"documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>DDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> </ul>"
|
||||
"documentation":"<p>Starts a job to restore a recovery point for one of the following resources:</p> <ul> <li> <p> <code>DynamoDB</code> for Amazon DynamoDB</p> </li> <li> <p> <code>EBS</code> for Amazon Elastic Block Store</p> </li> <li> <p> <code>EC2</code> for Amazon Elastic Compute Cloud</p> </li> <li> <p> <code>EFS</code> for Amazon Elastic File System</p> </li> <li> <p> <code>RDS</code> for Amazon Relational Database Service</p> </li> <li> <p> <code>Storage Gateway</code> for AWS Storage Gateway</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -178,7 +178,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.</p> <p>Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-what-is.html\">Optimizing Your Cost with Rightsizing Recommendations</a>.</p>"
|
||||
"documentation":"<p>Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.</p> <p>Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/ce-rightsizing.html\">Optimizing Your Cost with Rightsizing Recommendations</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p>"
|
||||
},
|
||||
"GetSavingsPlansCoverage":{
|
||||
"name":"GetSavingsPlansCoverage",
|
||||
|
|
@ -584,6 +584,10 @@
|
|||
"shape":"GenericString",
|
||||
"documentation":"<p>Resource ID of the current instance.</p>"
|
||||
},
|
||||
"InstanceName":{
|
||||
"shape":"GenericString",
|
||||
"documentation":"<p>The name you've given an instance. This field will show as blank if you haven't given the instance a name.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagValuesList",
|
||||
"documentation":"<p>Cost allocation resource tags applied to the instance.</p>"
|
||||
|
|
@ -1347,7 +1351,7 @@
|
|||
"Filter":{"shape":"Expression"},
|
||||
"Configuration":{
|
||||
"shape":"RightsizingRecommendationConfiguration",
|
||||
"documentation":"<p> Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether. </p>"
|
||||
"documentation":"<p> Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither. </p>"
|
||||
},
|
||||
"Service":{
|
||||
"shape":"GenericString",
|
||||
|
|
@ -1384,7 +1388,7 @@
|
|||
},
|
||||
"Configuration":{
|
||||
"shape":"RightsizingRecommendationConfiguration",
|
||||
"documentation":"<p>Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether. </p>"
|
||||
"documentation":"<p> Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1452,7 +1456,7 @@
|
|||
},
|
||||
"TermInYears":{
|
||||
"shape":"TermInYears",
|
||||
"documentation":"<p>The savings plan recommendation term used to generated these recommendations.</p>"
|
||||
"documentation":"<p>The savings plan recommendation term used to generate these recommendations.</p>"
|
||||
},
|
||||
"PaymentOption":{
|
||||
"shape":"PaymentOption",
|
||||
|
|
@ -2367,7 +2371,7 @@
|
|||
"documentation":"<p> The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is <code>TRUE</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether. </p>"
|
||||
"documentation":"<p> Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither. </p>"
|
||||
},
|
||||
"RightsizingRecommendationList":{
|
||||
"type":"list",
|
||||
|
|
@ -2382,7 +2386,7 @@
|
|||
},
|
||||
"GenerationTimestamp":{
|
||||
"shape":"GenericString",
|
||||
"documentation":"<p> The time stamp for when Amazon Web Services made this recommendation.</p>"
|
||||
"documentation":"<p> The timestamp for when Amazon Web Services made this recommendation.</p>"
|
||||
},
|
||||
"LookbackPeriodInDays":{
|
||||
"shape":"LookbackPeriodInDays",
|
||||
|
|
@ -2408,7 +2412,7 @@
|
|||
},
|
||||
"SavingsPercentage":{
|
||||
"shape":"GenericString",
|
||||
"documentation":"<p> Savings percentage based on the recommended modifications, relative to the total On Demand costs associated with these instances.</p>"
|
||||
"documentation":"<p> Savings percentage based on the recommended modifications, relative to the total On-Demand costs associated with these instances.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Summary of rightsizing recommendations </p>"
|
||||
|
|
|
|||
|
|
@ -656,6 +656,25 @@
|
|||
],
|
||||
"documentation":"<p>Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.</p>"
|
||||
},
|
||||
"DeleteVoiceConnectorEmergencyCallingConfiguration":{
|
||||
"name":"DeleteVoiceConnectorEmergencyCallingConfiguration",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"DeleteVoiceConnectorEmergencyCallingConfigurationRequest"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedClientException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ForbiddenException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"ThrottledClientException"},
|
||||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.</p>"
|
||||
},
|
||||
"DeleteVoiceConnectorGroup":{
|
||||
"name":"DeleteVoiceConnectorGroup",
|
||||
"http":{
|
||||
|
|
@ -693,7 +712,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the origination settings for the specified Amazon Chime Voice Connector.</p>"
|
||||
"documentation":"<p>Deletes the origination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.</p> </note>"
|
||||
},
|
||||
"DeleteVoiceConnectorProxy":{
|
||||
"name":"DeleteVoiceConnectorProxy",
|
||||
|
|
@ -750,7 +769,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the termination settings for the specified Amazon Chime Voice Connector.</p>"
|
||||
"documentation":"<p>Deletes the termination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.</p> </note>"
|
||||
},
|
||||
"DeleteVoiceConnectorTerminationCredentials":{
|
||||
"name":"DeleteVoiceConnectorTerminationCredentials",
|
||||
|
|
@ -1163,6 +1182,26 @@
|
|||
],
|
||||
"documentation":"<p>Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.</p>"
|
||||
},
|
||||
"GetVoiceConnectorEmergencyCallingConfiguration":{
|
||||
"name":"GetVoiceConnectorEmergencyCallingConfiguration",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationRequest"},
|
||||
"output":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationResponse"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedClientException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ForbiddenException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"ThrottledClientException"},
|
||||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.</p>"
|
||||
},
|
||||
"GetVoiceConnectorGroup":{
|
||||
"name":"GetVoiceConnectorGroup",
|
||||
"http":{
|
||||
|
|
@ -1695,6 +1734,26 @@
|
|||
],
|
||||
"documentation":"<p>Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/cloudtrail.html\">Logging Amazon Chime API Calls with AWS CloudTrail</a> in the <i>Amazon Chime Administration Guide</i>.</p> <p>To turn off existing retention settings, remove the number of days from the corresponding <b>RetentionDays</b> field in the <b>RetentionSettings</b> object. For more information about retention settings, see <a href=\"https://docs.aws.amazon.com/chime/latest/ag/chat-retention.html\">Managing Chat Retention Policies</a> in the <i>Amazon Chime Administration Guide</i>.</p>"
|
||||
},
|
||||
"PutVoiceConnectorEmergencyCallingConfiguration":{
|
||||
"name":"PutVoiceConnectorEmergencyCallingConfiguration",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationRequest"},
|
||||
"output":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationResponse"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedClientException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ForbiddenException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"ThrottledClientException"},
|
||||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.</p>"
|
||||
},
|
||||
"PutVoiceConnectorLoggingConfiguration":{
|
||||
"name":"PutVoiceConnectorLoggingConfiguration",
|
||||
"http":{
|
||||
|
|
@ -1733,7 +1792,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Adds origination settings for the specified Amazon Chime Voice Connector.</p>"
|
||||
"documentation":"<p>Adds origination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.</p> </note>"
|
||||
},
|
||||
"PutVoiceConnectorProxy":{
|
||||
"name":"PutVoiceConnectorProxy",
|
||||
|
|
@ -1794,7 +1853,7 @@
|
|||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Adds termination settings for the specified Amazon Chime Voice Connector.</p>"
|
||||
"documentation":"<p>Adds termination settings for the specified Amazon Chime Voice Connector.</p> <note> <p>If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.</p> </note>"
|
||||
},
|
||||
"PutVoiceConnectorTerminationCredentials":{
|
||||
"name":"PutVoiceConnectorTerminationCredentials",
|
||||
|
|
@ -2408,6 +2467,10 @@
|
|||
},
|
||||
"documentation":"<p>The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.</p>"
|
||||
},
|
||||
"Alpha2CountryCode":{
|
||||
"type":"string",
|
||||
"pattern":"[A-Z]{2}"
|
||||
},
|
||||
"AreaCode":{
|
||||
"type":"string",
|
||||
"pattern":"^$|^[0-9]{3,3}$"
|
||||
|
|
@ -2452,7 +2515,10 @@
|
|||
},
|
||||
"AssociatePhoneNumbersWithVoiceConnectorGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorGroupId"],
|
||||
"required":[
|
||||
"VoiceConnectorGroupId",
|
||||
"E164PhoneNumbers"
|
||||
],
|
||||
"members":{
|
||||
"VoiceConnectorGroupId":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -2481,7 +2547,10 @@
|
|||
},
|
||||
"AssociatePhoneNumbersWithVoiceConnectorRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorId"],
|
||||
"required":[
|
||||
"VoiceConnectorId",
|
||||
"E164PhoneNumbers"
|
||||
],
|
||||
"members":{
|
||||
"VoiceConnectorId":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -3366,6 +3435,32 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Credential"}
|
||||
},
|
||||
"DNISEmergencyCallingConfiguration":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"EmergencyPhoneNumber",
|
||||
"CallingCountry"
|
||||
],
|
||||
"members":{
|
||||
"EmergencyPhoneNumber":{
|
||||
"shape":"E164PhoneNumber",
|
||||
"documentation":"<p>The DNIS phone number to route emergency calls to, in E.164 format.</p>"
|
||||
},
|
||||
"TestPhoneNumber":{
|
||||
"shape":"E164PhoneNumber",
|
||||
"documentation":"<p>The DNIS phone number to route test emergency calls to, in E.164 format.</p>"
|
||||
},
|
||||
"CallingCountry":{
|
||||
"shape":"Alpha2CountryCode",
|
||||
"documentation":"<p>The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.</p>"
|
||||
},
|
||||
"DNISEmergencyCallingConfigurationList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DNISEmergencyCallingConfiguration"}
|
||||
},
|
||||
"DataRetentionInHours":{
|
||||
"type":"integer",
|
||||
"min":0
|
||||
|
|
@ -3523,6 +3618,18 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DeleteVoiceConnectorEmergencyCallingConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorId"],
|
||||
"members":{
|
||||
"VoiceConnectorId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The Amazon Chime Voice Connector ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"voiceConnectorId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteVoiceConnectorGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorGroupId"],
|
||||
|
|
@ -3585,7 +3692,10 @@
|
|||
},
|
||||
"DeleteVoiceConnectorTerminationCredentialsRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorId"],
|
||||
"required":[
|
||||
"Usernames",
|
||||
"VoiceConnectorId"
|
||||
],
|
||||
"members":{
|
||||
"VoiceConnectorId":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -3639,7 +3749,10 @@
|
|||
},
|
||||
"DisassociatePhoneNumbersFromVoiceConnectorGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorGroupId"],
|
||||
"required":[
|
||||
"VoiceConnectorGroupId",
|
||||
"E164PhoneNumbers"
|
||||
],
|
||||
"members":{
|
||||
"VoiceConnectorGroupId":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -3664,7 +3777,10 @@
|
|||
},
|
||||
"DisassociatePhoneNumbersFromVoiceConnectorRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorId"],
|
||||
"required":[
|
||||
"VoiceConnectorId",
|
||||
"E164PhoneNumbers"
|
||||
],
|
||||
"members":{
|
||||
"VoiceConnectorId":{
|
||||
"shape":"NonEmptyString",
|
||||
|
|
@ -3733,6 +3849,16 @@
|
|||
"Failed"
|
||||
]
|
||||
},
|
||||
"EmergencyCallingConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DNIS":{
|
||||
"shape":"DNISEmergencyCallingConfigurationList",
|
||||
"documentation":"<p>The Dialed Number Identification Service (DNIS) emergency calling configuration details.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The emergency calling configuration details associated with an Amazon Chime Voice Connector.</p>"
|
||||
},
|
||||
"ErrorCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -4183,6 +4309,27 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetVoiceConnectorEmergencyCallingConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorId"],
|
||||
"members":{
|
||||
"VoiceConnectorId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The Amazon Chime Voice Connector ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"voiceConnectorId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetVoiceConnectorEmergencyCallingConfigurationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EmergencyCallingConfiguration":{
|
||||
"shape":"EmergencyCallingConfiguration",
|
||||
"documentation":"<p>The emergency calling configuration details.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetVoiceConnectorGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["VoiceConnectorGroupId"],
|
||||
|
|
@ -5756,6 +5903,34 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"PutVoiceConnectorEmergencyCallingConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"VoiceConnectorId",
|
||||
"EmergencyCallingConfiguration"
|
||||
],
|
||||
"members":{
|
||||
"VoiceConnectorId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The Amazon Chime Voice Connector ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"voiceConnectorId"
|
||||
},
|
||||
"EmergencyCallingConfiguration":{
|
||||
"shape":"EmergencyCallingConfiguration",
|
||||
"documentation":"<p>The emergency calling configuration details.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutVoiceConnectorEmergencyCallingConfigurationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EmergencyCallingConfiguration":{
|
||||
"shape":"EmergencyCallingConfiguration",
|
||||
"documentation":"<p>The emergency calling configuration details.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutVoiceConnectorLoggingConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
|
|||
|
|
@ -564,7 +564,7 @@
|
|||
"errors":[
|
||||
{"shape":"StackSetNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region.</p>"
|
||||
"documentation":"<p>Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region, or that have a specific status.</p>"
|
||||
},
|
||||
"ListStackResources":{
|
||||
"name":"ListStackResources",
|
||||
|
|
@ -2655,6 +2655,10 @@
|
|||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"StackInstanceFilters",
|
||||
"documentation":"<p>The status that stack instances are filtered by.</p>"
|
||||
},
|
||||
"StackInstanceAccount":{
|
||||
"shape":"Account",
|
||||
"documentation":"<p>The name of the AWS account that you want to list stack instances for.</p>"
|
||||
|
|
@ -3608,7 +3612,7 @@
|
|||
"members":{
|
||||
"ResourceType":{
|
||||
"shape":"ResourceType",
|
||||
"documentation":"<p>The type of resource to import into your stack, such as <code>AWS::S3::Bucket</code>. </p>"
|
||||
"documentation":"<p>The type of resource to import into your stack, such as <code>AWS::S3::Bucket</code>. For a list of supported resource types, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html\">Resources that support import operations</a> in the AWS CloudFormation User Guide.</p>"
|
||||
},
|
||||
"LogicalResourceId":{
|
||||
"shape":"LogicalResourceId",
|
||||
|
|
@ -4020,6 +4024,10 @@
|
|||
"shape":"StackInstanceStatus",
|
||||
"documentation":"<p>The status of the stack instance, in terms of its synchronization with its associated stack set.</p> <ul> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually.</p> </li> <li> <p> <code>OUTDATED</code>: The stack isn't currently up to date with the stack set because:</p> <ul> <li> <p>The associated stack failed during a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation. </p> </li> <li> <p>The stack was part of a <code>CreateStackSet</code> or <code>UpdateStackSet</code> operation that failed or was stopped before the stack was created or updated. </p> </li> </ul> </li> <li> <p> <code>CURRENT</code>: The stack is currently up to date with the stack set.</p> </li> </ul>"
|
||||
},
|
||||
"StackInstanceStatus":{
|
||||
"shape":"StackInstanceComprehensiveStatus",
|
||||
"documentation":"<p>The detailed status of the stack instance.</p>"
|
||||
},
|
||||
"StatusReason":{
|
||||
"shape":"Reason",
|
||||
"documentation":"<p>The explanation for the specific status code that is assigned to this stack instance.</p>"
|
||||
|
|
@ -4039,6 +4047,55 @@
|
|||
},
|
||||
"documentation":"<p>An AWS CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.</p>"
|
||||
},
|
||||
"StackInstanceComprehensiveStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DetailedStatus":{
|
||||
"shape":"StackInstanceDetailedStatus",
|
||||
"documentation":"<ul> <li> <p> <code>CANCELLED</code>: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.</p> </li> <li> <p> <code>FAILED</code>: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.</p> </li> <li> <p> <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to <code>true</code>, to delete the stack instance, and then delete the stack manually.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and Region has yet to start.</p> </li> <li> <p> <code>RUNNING</code>: The operation in the specified account and Region is currently in progress.</p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and Region completed successfully.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The detailed status of the stack instance.</p>"
|
||||
},
|
||||
"StackInstanceDetailedStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PENDING",
|
||||
"RUNNING",
|
||||
"SUCCEEDED",
|
||||
"FAILED",
|
||||
"CANCELLED",
|
||||
"INOPERABLE"
|
||||
]
|
||||
},
|
||||
"StackInstanceFilter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"StackInstanceFilterName",
|
||||
"documentation":"<p>The type of filter to apply.</p>"
|
||||
},
|
||||
"Values":{
|
||||
"shape":"StackInstanceFilterValues",
|
||||
"documentation":"<p>The status to filter by.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The status that stack instances are filtered by.</p>"
|
||||
},
|
||||
"StackInstanceFilterName":{
|
||||
"type":"string",
|
||||
"enum":["DETAILED_STATUS"]
|
||||
},
|
||||
"StackInstanceFilterValues":{
|
||||
"type":"string",
|
||||
"max":10,
|
||||
"min":6
|
||||
},
|
||||
"StackInstanceFilters":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StackInstanceFilter"},
|
||||
"max":1
|
||||
},
|
||||
"StackInstanceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -4090,6 +4147,10 @@
|
|||
"shape":"Reason",
|
||||
"documentation":"<p>The explanation for the specific status code assigned to this stack instance.</p>"
|
||||
},
|
||||
"StackInstanceStatus":{
|
||||
"shape":"StackInstanceComprehensiveStatus",
|
||||
"documentation":"<p>The detailed status of the stack instance.</p>"
|
||||
},
|
||||
"OrganizationalUnitId":{
|
||||
"shape":"OrganizationalUnitId",
|
||||
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
|
||||
|
|
|
|||
|
|
@ -1368,7 +1368,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new origin access identity just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A</code>.</p>",
|
||||
"documentation":"<p>The fully qualified URI of the new origin access identity just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -1405,7 +1405,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>.</p>",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -1442,7 +1442,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>. </p>",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -1478,7 +1478,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new configuration resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5</code>.</p>",
|
||||
"documentation":"<p>The fully qualified URI of the new configuration resource just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -1513,7 +1513,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new profile resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5</code>.</p>",
|
||||
"documentation":"<p>The fully qualified URI of the new profile resource just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -1588,7 +1588,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new public key resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5</code>.</p>",
|
||||
"documentation":"<p>The fully qualified URI of the new public key resource just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -1624,7 +1624,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -1661,7 +1661,7 @@
|
|||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example:<code> https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
|
|
@ -3827,7 +3827,8 @@
|
|||
"TLSv1",
|
||||
"TLSv1_2016",
|
||||
"TLSv1.1_2016",
|
||||
"TLSv1.2_2018"
|
||||
"TLSv1.2_2018",
|
||||
"TLSv1.2_2019"
|
||||
]
|
||||
},
|
||||
"MissingBody":{
|
||||
|
|
@ -5411,11 +5412,11 @@
|
|||
},
|
||||
"SSLSupportMethod":{
|
||||
"shape":"SSLSupportMethod",
|
||||
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</p> <ul> <li> <p> <code>sni-only</code> – The distribution accepts HTTPS connections from only viewers that support <a href=\"https://en.wikipedia.org/wiki/Server_Name_Indication\">server name indication (SNI)</a>. This is recommended. Most browsers and clients released after 2010 support SNI.</p> </li> <li> <p> <code>vip</code> – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.</p> </li> </ul> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, don’t set a value for this field.</p>"
|
||||
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.</p> <ul> <li> <p> <code>sni-only</code> – The distribution accepts HTTPS connections from only viewers that support <a href=\"https://en.wikipedia.org/wiki/Server_Name_Indication\">server name indication (SNI)</a>. This is recommended. Most browsers and clients support SNI.</p> </li> <li> <p> <code>vip</code> – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.</p> </li> </ul> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>, don’t set a value for this field.</p>"
|
||||
},
|
||||
"MinimumProtocolVersion":{
|
||||
"shape":"MinimumProtocolVersion",
|
||||
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.</p> </li> <li> <p>The ciphers that CloudFront can use to encrypt the content that it returns to viewers.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy\">Security Policy</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers\">Supported Protocols and Ciphers Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>On the CloudFront console, this setting is called <b>Security Policy</b>.</p> </note> <p>We recommend that you specify <code>TLSv1.2_2018</code> unless your viewers are using browsers or devices that don’t support TLSv1.2.</p> <p>When you’re using SNI only (you set <code>SSLSupportMethod</code> to <code>sni-only</code>), you must specify <code>TLSv1</code> or higher. </p> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code> (you set <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you set here.</p>"
|
||||
"documentation":"<p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.</p> </li> <li> <p>The ciphers that CloudFront can use to encrypt the content that it returns to viewers.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy\">Security Policy</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers\">Supported Protocols and Ciphers Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>On the CloudFront console, this setting is called <b>Security Policy</b>.</p> </note> <p>When you’re using SNI only (you set <code>SSLSupportMethod</code> to <code>sni-only</code>), you must specify <code>TLSv1</code> or higher. </p> <p>If the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code> (you set <code>CloudFrontDefaultCertificate</code> to <code>true</code>), CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you set here.</p>"
|
||||
},
|
||||
"Certificate":{
|
||||
"shape":"string",
|
||||
|
|
@ -5428,7 +5429,7 @@
|
|||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.</p> <p>If the distribution doesn’t use <code>Aliases</code> (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>—set <code>CloudFrontDefaultCertificate</code> to <code>true</code> and leave all other fields empty.</p> <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:</p> <ul> <li> <p>Which viewers the distribution accepts HTTPS connections from: only viewers that support <a href=\"https://en.wikipedia.org/wiki/Server_Name_Indication\">server name indication (SNI)</a> (recommended), or all viewers including those that don’t support SNI.</p> <ul> <li> <p>To accept HTTPS connections from only viewers that support SNI, set <code>SSLSupportMethod</code> to <code>sni-only</code>. This is recommended. Most browsers and clients released after 2010 support SNI. </p> </li> <li> <p>To accept HTTPS connections from all viewers, including those that don’t support SNI, set <code>SSLSupportMethod</code> to <code>vip</code>. This is not recommended, and results in additional monthly charges from CloudFront. </p> </li> </ul> </li> <li> <p>The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for <code>MinimumProtocolVersion</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy\">Security Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> <li> <p>The location of the SSL/TLS certificate, <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html\">AWS Certificate Manager (ACM)</a> (recommended) or <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html\">AWS Identity and Access Management (AWS IAM)</a>. You specify the location by setting a value in one of the following fields (not both):</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> </ul> </li> </ul> <p>All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use <code>ViewerProtocolPolicy</code> in the <code>CacheBehavior</code> or <code>DefaultCacheBehavior</code>. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use <code>CustomOriginConfig</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html\">Using HTTPS with CloudFront</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html\"> Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
"documentation":"<p>A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.</p> <p>If the distribution doesn’t use <code>Aliases</code> (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as <code>d111111abcdef8.cloudfront.net</code>—set <code>CloudFrontDefaultCertificate</code> to <code>true</code> and leave all other fields empty.</p> <p>If the distribution uses <code>Aliases</code> (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:</p> <ul> <li> <p>Which viewers the distribution accepts HTTPS connections from: only viewers that support <a href=\"https://en.wikipedia.org/wiki/Server_Name_Indication\">server name indication (SNI)</a> (recommended), or all viewers including those that don’t support SNI.</p> <ul> <li> <p>To accept HTTPS connections from only viewers that support SNI, set <code>SSLSupportMethod</code> to <code>sni-only</code>. This is recommended. Most browsers and clients support SNI. </p> </li> <li> <p>To accept HTTPS connections from all viewers, including those that don’t support SNI, set <code>SSLSupportMethod</code> to <code>vip</code>. This is not recommended, and results in additional monthly charges from CloudFront. </p> </li> </ul> </li> <li> <p>The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for <code>MinimumProtocolVersion</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy\">Security Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> <li> <p>The location of the SSL/TLS certificate, <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html\">AWS Certificate Manager (ACM)</a> (recommended) or <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html\">AWS Identity and Access Management (AWS IAM)</a>. You specify the location by setting a value in one of the following fields (not both):</p> <ul> <li> <p> <code>ACMCertificateArn</code> </p> </li> <li> <p> <code>IAMCertificateId</code> </p> </li> </ul> </li> </ul> <p>All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use <code>ViewerProtocolPolicy</code> in the <code>CacheBehavior</code> or <code>DefaultCacheBehavior</code>. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use <code>CustomOriginConfig</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html\">Using HTTPS with CloudFront</a> and <a href=\"https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html\"> Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"ViewerProtocolPolicy":{
|
||||
"type":"string",
|
||||
|
|
|
|||
|
|
@ -270,7 +270,7 @@
|
|||
},
|
||||
"SourceRegion":{
|
||||
"shape":"Region",
|
||||
"documentation":"<p>The AWS region that contains the source backup from which the new backup was copied.</p>"
|
||||
"documentation":"<p>The AWS Region that contains the source backup from which the new backup was copied.</p>"
|
||||
},
|
||||
"SourceBackup":{
|
||||
"shape":"BackupId",
|
||||
|
|
@ -278,13 +278,16 @@
|
|||
},
|
||||
"SourceCluster":{
|
||||
"shape":"ClusterId",
|
||||
"documentation":"<p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied. .</p>"
|
||||
"documentation":"<p>The identifier (ID) of the cluster containing the source backup from which the new backup was copied.</p>"
|
||||
},
|
||||
"DeleteTimestamp":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the backup will be permanently deleted.</p>"
|
||||
},
|
||||
"TagList":{"shape":"TagList"}
|
||||
"TagList":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The list of tags for the backup.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion paramters. A backup that is pending deletion will include the DeleteTimestamp parameter.</p>"
|
||||
},
|
||||
|
|
@ -387,6 +390,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"documentation":"<p>The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"Cluster":{
|
||||
|
|
@ -444,7 +448,10 @@
|
|||
"shape":"Certificates",
|
||||
"documentation":"<p>Contains one or more certificates or a certificate signing request (CSR).</p>"
|
||||
},
|
||||
"TagList":{"shape":"TagList"}
|
||||
"TagList":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The list of tags for the cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about an AWS CloudHSM cluster.</p>"
|
||||
},
|
||||
|
|
@ -485,7 +492,10 @@
|
|||
"shape":"BackupId",
|
||||
"documentation":"<p>The ID of the backup that will be copied to the destination region. </p>"
|
||||
},
|
||||
"TagList":{"shape":"TagList"}
|
||||
"TagList":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CopyBackupToRegionResponse":{
|
||||
|
|
@ -516,7 +526,10 @@
|
|||
"shape":"BackupId",
|
||||
"documentation":"<p>The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use <a>DescribeBackups</a>.</p>"
|
||||
},
|
||||
"TagList":{"shape":"TagList"}
|
||||
"TagList":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>Tags to apply to the CloudHSM cluster during creation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateClusterResponse":{
|
||||
|
|
|
|||
|
|
@ -864,6 +864,20 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"BuildStatusConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"context":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>name</code> parameter in the Bitbucket commit status. For more information, see <a href=\"https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build\">build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>context</code> parameter in the GitHub commit status. For more information, see <a href=\"https://developer.github.com/v3/repos/statuses/#create-a-commit-status\">Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>"
|
||||
},
|
||||
"targetUrl":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>url</code> parameter in the Bitbucket commit status. For more information, see <a href=\"https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build\">build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>target_url</code> parameter in the GitHub commit status. For more information, see <a href=\"https://developer.github.com/v3/repos/statuses/#create-a-commit-status\">Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider. </p>"
|
||||
},
|
||||
"Builds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Build"}
|
||||
|
|
@ -2172,7 +2186,7 @@
|
|||
"members":{
|
||||
"type":{
|
||||
"shape":"SourceType",
|
||||
"documentation":"<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise repository.</p> </li> <li> <p> <code>NO_SOURCE</code>: The project does not have input source code.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.</p> </li> </ul>"
|
||||
"documentation":"<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub or GitHub Enterprise Cloud repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise Server repository.</p> </li> <li> <p> <code>NO_SOURCE</code>: The project does not have input source code.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.</p> </li> </ul>"
|
||||
},
|
||||
"location":{
|
||||
"shape":"String",
|
||||
|
|
@ -2198,6 +2212,10 @@
|
|||
"shape":"WrapperBoolean",
|
||||
"documentation":"<p> Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. </p> <note> <p> The status of a build triggered by a webhook is always reported to your source provider. </p> </note>"
|
||||
},
|
||||
"buildStatusConfig":{
|
||||
"shape":"BuildStatusConfig",
|
||||
"documentation":"<p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>"
|
||||
},
|
||||
"insecureSsl":{
|
||||
"shape":"WrapperBoolean",
|
||||
"documentation":"<p>Enable this flag to ignore SSL warnings while connecting to the project source code.</p>"
|
||||
|
|
@ -2667,6 +2685,10 @@
|
|||
"shape":"WrapperBoolean",
|
||||
"documentation":"<p> Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. </p> <note> <p> The status of a build triggered by a webhook is always reported to your source provider. </p> </note>"
|
||||
},
|
||||
"buildStatusConfigOverride":{
|
||||
"shape":"BuildStatusConfig",
|
||||
"documentation":"<p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>"
|
||||
},
|
||||
"environmentTypeOverride":{
|
||||
"shape":"EnvironmentType",
|
||||
"documentation":"<p>A container type for this build that overrides the one specified in the build project.</p>"
|
||||
|
|
@ -2709,7 +2731,7 @@
|
|||
},
|
||||
"idempotencyToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error. </p>"
|
||||
"documentation":"<p>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error. </p>"
|
||||
},
|
||||
"logsConfigOverride":{
|
||||
"shape":"LogsConfig",
|
||||
|
|
@ -3083,7 +3105,7 @@
|
|||
"members":{
|
||||
"type":{
|
||||
"shape":"WebhookFilterType",
|
||||
"documentation":"<p> The type of webhook filter. There are five webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, and <code>FILE_PATH</code>. </p> <dl> <dt> EVENT </dt> <dd> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of five event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, <code>PULL_REQUEST_REOPENED</code>, and <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub Enterprise only. </p> </note> </dd> <dt> ACTOR_ACCOUNT_ID </dt> <dd> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </dd> <dt> HEAD_REF </dt> <dd> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events. </p> </dd> <dt> BASE_REF </dt> <dd> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </dd> <dt> FILE_PATH </dt> <dd> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and GitHub Enterprise push events only. </p> </note> </dd> </dl>"
|
||||
"documentation":"<p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p> <dl> <dt> EVENT </dt> <dd> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of five event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, <code>PULL_REQUEST_REOPENED</code>, and <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub Enterprise only. </p> </note> </dd> <dt> ACTOR_ACCOUNT_ID </dt> <dd> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </dd> <dt> HEAD_REF </dt> <dd> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events. </p> </dd> <dt> BASE_REF </dt> <dd> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </dd> <dt> FILE_PATH </dt> <dd> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </dd> <dt>COMMIT_MESSAGE</dt> <dd> <p>A webhook triggers a build when the head commit message matches the regular expression <code>pattern</code>.</p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </dd> </dl>"
|
||||
},
|
||||
"pattern":{
|
||||
"shape":"String",
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -28,7 +28,7 @@
|
|||
{"shape":"ConflictException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request raised within the repository. You can view recommendations in the AWS CodeCommit repository.</p> <p>You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.</p>"
|
||||
"documentation":"<p> Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html\">Recommendations in Amazon CodeGuru Reviewer</a> in the <i>Amazon CodeGuru Reviewer User Guide.</i> </p> <p>If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.</p> <p> Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/reviewer-ug/step-one.html#select-repository-source-provider\">Connect to a repository source provider</a> in the <i>Amazon CodeGuru Reviewer User Guide.</i> </p> <note> <p> You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html\">Getting started with CodeGuru Reviewer</a> in the <i>CodeGuru Reviewer User Guide.</i> </p> </note>"
|
||||
},
|
||||
"DescribeCodeReview":{
|
||||
"name":"DescribeCodeReview",
|
||||
|
|
@ -45,7 +45,7 @@
|
|||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p> Returns the metadaata associated with the code review along with its status.</p>"
|
||||
"documentation":"<p> Returns the metadata associated with the code review along with its status.</p>"
|
||||
},
|
||||
"DescribeRecommendationFeedback":{
|
||||
"name":"DescribeRecommendationFeedback",
|
||||
|
|
@ -79,7 +79,7 @@
|
|||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Describes a repository association.</p>"
|
||||
"documentation":"<p> Returns a <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html\"> <code>RepositoryAssociation</code> </a> object that contains information about the requested repository association. </p>"
|
||||
},
|
||||
"DisassociateRepository":{
|
||||
"name":"DisassociateRepository",
|
||||
|
|
@ -130,7 +130,7 @@
|
|||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p> Lists the customer feedback for a CodeGuru Reviewer recommendation for all users. This API will be used from the console to extract the previously given feedback by the user to pre-populate the feedback emojis for all recommendations. </p>"
|
||||
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html\"> <code>RecommendationFeedbackSummary</code> </a> objects that contain customer recommendation feedback for all CodeGuru Reviewer users. </p>"
|
||||
},
|
||||
"ListRecommendations":{
|
||||
"name":"ListRecommendations",
|
||||
|
|
@ -162,7 +162,7 @@
|
|||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.</p>"
|
||||
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html\"> <code>RepositoryAssociationSummary</code> </a> objects that contain summary information about a repository association. You can filter the returned list by <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType\"> <code>ProviderType</code> </a>, <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name\"> <code>Name</code> </a>, <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State\"> <code>State</code> </a>, and <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner\"> <code>Owner</code> </a>. </p>"
|
||||
},
|
||||
"PutRecommendationFeedback":{
|
||||
"name":"PutRecommendationFeedback",
|
||||
|
|
@ -179,7 +179,7 @@
|
|||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p> Stores customer feedback for a CodeGuru-Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. </p>"
|
||||
"documentation":"<p> Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -239,10 +239,10 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the AWS CodeCommit repository.</p>"
|
||||
"documentation":"<p>The name of the AWS CodeCommit repository. For more information, see <a href=\"https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetRepository.html#CodeCommit-GetRepository-request-repositoryName\">repositoryName</a> in the <i>AWS CodeCommit API Reference</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about an AWS CodeCommit repository.</p>"
|
||||
"documentation":"<p>Information about an AWS CodeCommit repository. The CodeCommit repository must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured. </p>"
|
||||
},
|
||||
"CodeReview":{
|
||||
"type":"structure",
|
||||
|
|
@ -253,7 +253,7 @@
|
|||
},
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>"
|
||||
},
|
||||
"RepositoryName":{
|
||||
"shape":"Name",
|
||||
|
|
@ -261,15 +261,15 @@
|
|||
},
|
||||
"Owner":{
|
||||
"shape":"Owner",
|
||||
"documentation":"<p> The owner of the repository. </p>"
|
||||
"documentation":"<p>The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
"documentation":"<p> The provider type of the repository association. </p>"
|
||||
"documentation":"<p> The type of repository that contains the reviewed code (for example, GitHub or Bitbucket). </p>"
|
||||
},
|
||||
"State":{
|
||||
"shape":"JobState",
|
||||
"documentation":"<p> The state of the code review. </p>"
|
||||
"documentation":"<p>The valid code review states are:</p> <ul> <li> <p> <code>Completed</code>: The code review is complete. </p> </li> <li> <p> <code>Pending</code>: The code review started and has not completed or failed. </p> </li> <li> <p> <code>Failed</code>: The code review failed. </p> </li> <li> <p> <code>Deleting</code>: The code review is being deleted. </p> </li> </ul>"
|
||||
},
|
||||
"StateReason":{
|
||||
"shape":"StateReason",
|
||||
|
|
@ -315,7 +315,7 @@
|
|||
},
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>"
|
||||
},
|
||||
"RepositoryName":{
|
||||
"shape":"Name",
|
||||
|
|
@ -323,7 +323,7 @@
|
|||
},
|
||||
"Owner":{
|
||||
"shape":"Owner",
|
||||
"documentation":"<p> The owner of the repository. </p>"
|
||||
"documentation":"<p>The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
|
|
@ -331,7 +331,7 @@
|
|||
},
|
||||
"State":{
|
||||
"shape":"JobState",
|
||||
"documentation":"<p> The state of the code review. </p>"
|
||||
"documentation":"<p> The state of the code review. </p> <p>The valid code review states are:</p> <ul> <li> <p> <code>Completed</code>: The code review is complete. </p> </li> <li> <p> <code>Pending</code>: The code review started and has not completed or failed. </p> </li> <li> <p> <code>Failed</code>: The code review failed. </p> </li> <li> <p> <code>Deleting</code>: The code review is being deleted. </p> </li> </ul>"
|
||||
},
|
||||
"CreatedTimeStamp":{
|
||||
"shape":"TimeStamp",
|
||||
|
|
@ -361,11 +361,11 @@
|
|||
"members":{
|
||||
"SourceCommit":{
|
||||
"shape":"CommitId",
|
||||
"documentation":"<p> Source Commit SHA. </p>"
|
||||
"documentation":"<p> The SHA of the source commit. </p>"
|
||||
},
|
||||
"DestinationCommit":{
|
||||
"shape":"CommitId",
|
||||
"documentation":"<p> Destination Commit SHA </p>"
|
||||
"documentation":"<p> The SHA of the destination commit. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The commit diff for the pull request. </p>"
|
||||
|
|
@ -396,7 +396,7 @@
|
|||
"members":{
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"CodeReviewArn"
|
||||
}
|
||||
|
|
@ -420,7 +420,7 @@
|
|||
"members":{
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"CodeReviewArn"
|
||||
},
|
||||
|
|
@ -432,7 +432,7 @@
|
|||
},
|
||||
"UserId":{
|
||||
"shape":"UserId",
|
||||
"documentation":"<p> Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request. </p>",
|
||||
"documentation":"<p> Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request. </p> <p> The <code>UserId</code> is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying\"> Specifying a Principal</a> in the <i>AWS Identity and Access Management User Guide</i>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"UserId"
|
||||
}
|
||||
|
|
@ -453,7 +453,7 @@
|
|||
"members":{
|
||||
"AssociationArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) identifying the association. You can retrieve this ARN by calling <code>ListRepositories</code>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html\"> <code>RepositoryAssociation</code> </a> object. You can retrieve this ARN by calling <code>ListRepositories</code>.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AssociationArn"
|
||||
}
|
||||
|
|
@ -474,7 +474,7 @@
|
|||
"members":{
|
||||
"AssociationArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) identifying the association.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html\"> <code>RepositoryAssociation</code> </a> object. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"AssociationArn"
|
||||
}
|
||||
|
|
@ -533,13 +533,13 @@
|
|||
"members":{
|
||||
"ProviderTypes":{
|
||||
"shape":"ProviderTypes",
|
||||
"documentation":"<p> List of provider types for filtering that needs to be applied before displaying the result. For example, \"providerTypes=[GitHub]\" will list code reviews from GitHub. </p>",
|
||||
"documentation":"<p> List of provider types for filtering that needs to be applied before displaying the result. For example, <code>providerTypes=[GitHub]</code> lists code reviews from GitHub. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"ProviderTypes"
|
||||
},
|
||||
"States":{
|
||||
"shape":"JobStates",
|
||||
"documentation":"<p> List of states for filtering that needs to be applied before displaying the result. For example, \"states=[Pending]\" will list code reviews in the Pending state. </p>",
|
||||
"documentation":"<p> List of states for filtering that needs to be applied before displaying the result. For example, <code>states=[Pending]</code> lists code reviews in the Pending state. </p> <p>The valid code review states are:</p> <ul> <li> <p> <code>Completed</code>: The code review is complete. </p> </li> <li> <p> <code>Pending</code>: The code review started and has not completed or failed. </p> </li> <li> <p> <code>Failed</code>: The code review failed. </p> </li> <li> <p> <code>Deleting</code>: The code review is being deleted. </p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"States"
|
||||
},
|
||||
|
|
@ -588,7 +588,7 @@
|
|||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p> If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>",
|
||||
"documentation":"<p> If <code>nextToken</code> is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"NextToken"
|
||||
},
|
||||
|
|
@ -600,19 +600,19 @@
|
|||
},
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"CodeReviewArn"
|
||||
},
|
||||
"UserIds":{
|
||||
"shape":"UserIds",
|
||||
"documentation":"<p> Filter on userIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a code review from a given user. </p>",
|
||||
"documentation":"<p> An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user. </p> <p> The <code>UserId</code> is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying\"> Specifying a Principal</a> in the <i>AWS Identity and Access Management User Guide</i>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"UserIds"
|
||||
},
|
||||
"RecommendationIds":{
|
||||
"shape":"RecommendationIds",
|
||||
"documentation":"<p> Filter on recommendationIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a given recommendation. </p>",
|
||||
"documentation":"<p> Used to query the recommendation feedback for a given recommendation. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"RecommendationIds"
|
||||
}
|
||||
|
|
@ -623,7 +623,7 @@
|
|||
"members":{
|
||||
"RecommendationFeedbackSummaries":{
|
||||
"shape":"RecommendationFeedbackSummaries",
|
||||
"documentation":"<p> Recommendation feedback summaries corresponding to the code reivew ARN. </p>"
|
||||
"documentation":"<p> Recommendation feedback summaries corresponding to the code review ARN. </p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -649,7 +649,7 @@
|
|||
},
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of the code review to describe. </p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"CodeReviewArn"
|
||||
}
|
||||
|
|
@ -679,7 +679,7 @@
|
|||
},
|
||||
"States":{
|
||||
"shape":"RepositoryAssociationStates",
|
||||
"documentation":"<p>List of states to use as a filter.</p>",
|
||||
"documentation":"<p>List of repository association states to use as a filter.</p> <p>The valid repository association states are:</p> <ul> <li> <p> <b>Associated</b>: The repository association is complete. </p> </li> <li> <p> <b>Associating</b>: CodeGuru Reviewer is: </p> <ul> <li> <p> Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review. </p> <note> <p> If your repository <code>ProviderType</code> is <code>GitHub</code> or <code>Bitbucket</code>, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered. </p> </note> </li> <li> <p> Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository. </p> </li> </ul> </li> <li> <p> <b>Failed</b>: The repository failed to associate or disassociate. </p> </li> <li> <p> <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and source code access. </p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"State"
|
||||
},
|
||||
|
|
@ -691,13 +691,13 @@
|
|||
},
|
||||
"Owners":{
|
||||
"shape":"Owners",
|
||||
"documentation":"<p>List of owners to use as a filter. For GitHub, this is name of the GitHub account that was used to associate the repository. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository.</p>",
|
||||
"documentation":"<p>List of owners to use as a filter. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket, this is name of the account that was used to associate the repository. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Owner"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of repository association results returned by <code>ListRepositoryAssociations</code> in paginated output. When this parameter is used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results in a single page with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRepositoryAssociations</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 25. If this parameter is not used, <code>ListRepositoryAssociations</code> returns up to 25 results and a <code>nextToken</code> value if applicable. </p>",
|
||||
"documentation":"<p>The maximum number of repository association results returned by <code>ListRepositoryAssociations</code> in paginated output. When this parameter is used, <code>ListRepositoryAssociations</code> only returns <code>maxResults</code> results in a single page with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListRepositoryAssociations</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, <code>ListRepositoryAssociations</code> returns up to 100 results and a <code>nextToken</code> value if applicable. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxResults"
|
||||
},
|
||||
|
|
@ -733,7 +733,7 @@
|
|||
"members":{
|
||||
"MeteredLinesOfCodeCount":{
|
||||
"shape":"MeteredLinesOfCodeCount",
|
||||
"documentation":"<p> Lines of code metered in the code review. </p>"
|
||||
"documentation":"<p> Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, <code>MeteredLinesOfCodeCount</code> includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code. </p>"
|
||||
},
|
||||
"FindingsCount":{
|
||||
"shape":"FindingsCount",
|
||||
|
|
@ -747,7 +747,7 @@
|
|||
"members":{
|
||||
"MeteredLinesOfCodeCount":{
|
||||
"shape":"MeteredLinesOfCodeCount",
|
||||
"documentation":"<p> Lines of code metered in the code review. </p>"
|
||||
"documentation":"<p> Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, <code>MeteredLinesOfCodeCount</code> includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code. </p>"
|
||||
},
|
||||
"FindingsCount":{
|
||||
"shape":"FindingsCount",
|
||||
|
|
@ -799,7 +799,8 @@
|
|||
"enum":[
|
||||
"CodeCommit",
|
||||
"GitHub",
|
||||
"Bitbucket"
|
||||
"Bitbucket",
|
||||
"GitHubEnterpriseServer"
|
||||
]
|
||||
},
|
||||
"ProviderTypes":{
|
||||
|
|
@ -823,7 +824,7 @@
|
|||
"members":{
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>"
|
||||
},
|
||||
"RecommendationId":{
|
||||
"shape":"RecommendationId",
|
||||
|
|
@ -858,7 +859,7 @@
|
|||
"members":{
|
||||
"CodeReviewArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) that identifies the code review. </p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html\"> <code>CodeReview</code> </a> object. </p>"
|
||||
},
|
||||
"RecommendationId":{
|
||||
"shape":"RecommendationId",
|
||||
|
|
@ -870,7 +871,7 @@
|
|||
},
|
||||
"UserId":{
|
||||
"shape":"UserId",
|
||||
"documentation":"<p> The user principal that made the API call. </p>"
|
||||
"documentation":"<p> The ID of the user that made the API call. </p> <p> The <code>UserId</code> is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying\"> Specifying a Principal</a> in the <i>AWS Identity and Access Management User Guide</i>. </p>"
|
||||
},
|
||||
"CreatedTimeStamp":{
|
||||
"shape":"TimeStamp",
|
||||
|
|
@ -900,7 +901,7 @@
|
|||
},
|
||||
"UserId":{
|
||||
"shape":"UserId",
|
||||
"documentation":"<p> The identifier for the user that gave the feedback. </p>"
|
||||
"documentation":"<p> The ID of the user that gave the feedback. </p> <p> The <code>UserId</code> is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying\"> Specifying a Principal</a> in the <i>AWS Identity and Access Management User Guide</i>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Information about recommendation feedback summaries. </p>"
|
||||
|
|
@ -937,7 +938,7 @@
|
|||
},
|
||||
"EndLine":{
|
||||
"shape":"LineNumber",
|
||||
"documentation":"<p> Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values will be the same. </p>"
|
||||
"documentation":"<p> Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same. </p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"Text",
|
||||
|
|
@ -955,10 +956,14 @@
|
|||
},
|
||||
"Bitbucket":{
|
||||
"shape":"ThirdPartySourceRepository",
|
||||
"documentation":"<p> Information about a Bitbucket Cloud repository. </p>"
|
||||
"documentation":"<p> Information about a Bitbucket repository. </p>"
|
||||
},
|
||||
"GitHubEnterpriseServer":{
|
||||
"shape":"ThirdPartySourceRepository",
|
||||
"documentation":"<p> Information about a GitHub Enterprise Server repository. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a repository.</p>"
|
||||
"documentation":"<p> Information about an associated AWS CodeCommit repository or an associated repository that is managed by AWS CodeStar Connections (for example, Bitbucket). This <code>Repository</code> object is not used if your source code is in an associated GitHub repository. </p>"
|
||||
},
|
||||
"RepositoryAssociation":{
|
||||
"type":"structure",
|
||||
|
|
@ -973,7 +978,7 @@
|
|||
},
|
||||
"ConnectionArn":{
|
||||
"shape":"ConnectionArn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) identifying the repository connection. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href=\"https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html\">Connection</a> in the <i>AWS CodeStar Connections API Reference</i>. </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"Name",
|
||||
|
|
@ -981,7 +986,7 @@
|
|||
},
|
||||
"Owner":{
|
||||
"shape":"Owner",
|
||||
"documentation":"<p>The owner of the repository.</p>"
|
||||
"documentation":"<p>The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
|
|
@ -989,7 +994,7 @@
|
|||
},
|
||||
"State":{
|
||||
"shape":"RepositoryAssociationState",
|
||||
"documentation":"<p>The state of the repository association.</p>"
|
||||
"documentation":"<p>The state of the repository association.</p> <p>The valid repository association states are:</p> <ul> <li> <p> <b>Associated</b>: The repository association is complete. </p> </li> <li> <p> <b>Associating</b>: CodeGuru Reviewer is: </p> <ul> <li> <p> Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review. </p> <note> <p> If your repository <code>ProviderType</code> is <code>GitHub</code> or <code>Bitbucket</code>, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered. </p> </note> </li> <li> <p> Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository. </p> </li> </ul> </li> <li> <p> <b>Failed</b>: The repository failed to associate or disassociate. </p> </li> <li> <p> <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and source code access. </p> </li> </ul>"
|
||||
},
|
||||
"StateReason":{
|
||||
"shape":"StateReason",
|
||||
|
|
@ -1004,7 +1009,7 @@
|
|||
"documentation":"<p>The time, in milliseconds since the epoch, when the repository association was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a repository association.</p>"
|
||||
"documentation":"<p>Information about a repository association. The <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_DescribeRepositoryAssociation.html\"> <code>DescribeRepositoryAssociation</code> </a> operation returns a <code>RepositoryAssociation</code> object.</p>"
|
||||
},
|
||||
"RepositoryAssociationState":{
|
||||
"type":"string",
|
||||
|
|
@ -1030,11 +1035,11 @@
|
|||
"members":{
|
||||
"AssociationArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) identifying the repository association.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html\"> <code>RepositoryAssociation</code> </a> object. </p>"
|
||||
},
|
||||
"ConnectionArn":{
|
||||
"shape":"ConnectionArn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) identifying the repository connection. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href=\"https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html\">Connection</a> in the <i>AWS CodeStar Connections API Reference</i>. </p>"
|
||||
},
|
||||
"LastUpdatedTimeStamp":{
|
||||
"shape":"TimeStamp",
|
||||
|
|
@ -1042,7 +1047,7 @@
|
|||
},
|
||||
"AssociationId":{
|
||||
"shape":"AssociationId",
|
||||
"documentation":"<p>The repository association ID.</p>"
|
||||
"documentation":"<p> The repository association ID. </p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"Name",
|
||||
|
|
@ -1050,7 +1055,7 @@
|
|||
},
|
||||
"Owner":{
|
||||
"shape":"Owner",
|
||||
"documentation":"<p>The owner of the repository association.</p>"
|
||||
"documentation":"<p>The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
|
|
@ -1058,10 +1063,10 @@
|
|||
},
|
||||
"State":{
|
||||
"shape":"RepositoryAssociationState",
|
||||
"documentation":"<p>The state of the repository association.</p> <dl> <dt>Associated</dt> <dd> <p>Amazon CodeGuru Reviewer is associated with the repository. </p> </dd> <dt>Associating</dt> <dd> <p>The association is in progress. </p> </dd> <dt>Failed</dt> <dd> <p>The association failed. </p> </dd> <dt>Disassociating</dt> <dd> <p>Amazon CodeGuru Reviewer is in the process of disassociating with the repository. </p> </dd> </dl>"
|
||||
"documentation":"<p>The state of the repository association.</p> <p>The valid repository association states are:</p> <ul> <li> <p> <b>Associated</b>: The repository association is complete. </p> </li> <li> <p> <b>Associating</b>: CodeGuru Reviewer is: </p> <ul> <li> <p> Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review. </p> <note> <p> If your repository <code>ProviderType</code> is <code>GitHub</code> or <code>Bitbucket</code>, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered. </p> </note> </li> <li> <p> Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository. </p> </li> </ul> </li> <li> <p> <b>Failed</b>: The repository failed to associate or disassociate. </p> </li> <li> <p> <b>Disassociating</b>: CodeGuru Reviewer is removing the repository's pull request notifications and source code access. </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a repository association.</p>"
|
||||
"documentation":"<p>Summary information about a repository association. The <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_ListRepositoryAssociations.html\"> <code>ListRepositoryAssociations</code> </a> operation returns a list of <code>RepositoryAssociationSummary</code> objects.</p>"
|
||||
},
|
||||
"RepositoryNames":{
|
||||
"type":"list",
|
||||
|
|
@ -1112,14 +1117,14 @@
|
|||
},
|
||||
"ConnectionArn":{
|
||||
"shape":"ConnectionArn",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) identifying the repository connection. </p>"
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is <code>arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id</code>. For more information, see <a href=\"https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html\">Connection</a> in the <i>AWS CodeStar Connections API Reference</i>. </p>"
|
||||
},
|
||||
"Owner":{
|
||||
"shape":"Owner",
|
||||
"documentation":"<p> The username of the owner of the repository. </p>"
|
||||
"documentation":"<p> The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Information about a third party source repository connected through CodeStar Connections. </p>"
|
||||
"documentation":"<p> Information about a third-party source repository connected to CodeGuru Reviewer. </p>"
|
||||
},
|
||||
"ThrottlingException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1156,5 +1161,5 @@
|
|||
"exception":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. Amazon CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java code.</p> <p>By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html\">Amazon CodeGuru Reviewer User Guide</a>.</p>"
|
||||
"documentation":"<p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java code.</p> <p>By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the <i> <a href=\"https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html\">Amazon CodeGuru Reviewer User Guide</a>.</i> </p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -12,6 +12,42 @@
|
|||
"uid":"codeguruprofiler-2019-07-18"
|
||||
},
|
||||
"operations":{
|
||||
"AddNotificationChannels":{
|
||||
"name":"AddNotificationChannels",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/profilingGroups/{profilingGroupName}/notificationConfiguration",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"AddNotificationChannelsRequest"},
|
||||
"output":{"shape":"AddNotificationChannelsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Add up to 2 anomaly notifications channels for a profiling group.</p>"
|
||||
},
|
||||
"BatchGetFrameMetricData":{
|
||||
"name":"BatchGetFrameMetricData",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/profilingGroups/{profilingGroupName}/frames/-/metrics",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"BatchGetFrameMetricDataRequest"},
|
||||
"output":{"shape":"BatchGetFrameMetricDataResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p> Returns the time series of values for a requested list of frame metrics from a time period.</p>"
|
||||
},
|
||||
"ConfigureAgent":{
|
||||
"name":"ConfigureAgent",
|
||||
"http":{
|
||||
|
|
@ -27,7 +63,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> Used by profiler agents to report their current state and to receive remote configuration updates. For example, <code>ConfigureAgent</code> can be used to tell and agent whether to profile or not and for how long to return profiling data. </p>"
|
||||
},
|
||||
"CreateProfilingGroup":{
|
||||
"name":"CreateProfilingGroup",
|
||||
|
|
@ -81,7 +117,40 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Describes a profiling group.</p>"
|
||||
"documentation":"<p> Returns a <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> object that contains information about the requested profiling group. </p>"
|
||||
},
|
||||
"GetFindingsReportAccountSummary":{
|
||||
"name":"GetFindingsReportAccountSummary",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/internal/findingsReports",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetFindingsReportAccountSummaryRequest"},
|
||||
"output":{"shape":"GetFindingsReportAccountSummaryResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html\"> <code>FindingsReportSummary</code> </a> objects that contain analysis results for all profiling groups in your AWS account. </p>"
|
||||
},
|
||||
"GetNotificationConfiguration":{
|
||||
"name":"GetNotificationConfiguration",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/profilingGroups/{profilingGroupName}/notificationConfiguration",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetNotificationConfigurationRequest"},
|
||||
"output":{"shape":"GetNotificationConfigurationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Get the current configuration for anomaly notifications for a profiling group.</p>"
|
||||
},
|
||||
"GetPolicy":{
|
||||
"name":"GetPolicy",
|
||||
|
|
@ -97,7 +166,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Gets the profiling group policy.</p>"
|
||||
"documentation":"<p> Returns the JSON-formatted resource-based policy on a profiling group. </p>"
|
||||
},
|
||||
"GetProfile":{
|
||||
"name":"GetProfile",
|
||||
|
|
@ -114,7 +183,41 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. </p> <p>For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20. </p> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>"
|
||||
"documentation":"<p> Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles. </p> <pre><code> <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol> </code></pre>"
|
||||
},
|
||||
"GetRecommendations":{
|
||||
"name":"GetRecommendations",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/internal/profilingGroups/{profilingGroupName}/recommendations",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetRecommendationsRequest"},
|
||||
"output":{"shape":"GetRecommendationsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p> Returns a list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Recommendation.html\"> <code>Recommendation</code> </a> objects that contain recommendations for a profiling group for a given time period. A list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_Anomaly.html\"> <code>Anomaly</code> </a> objects that contains details about anomalies detected in the profiling group for the same time period is also returned. </p>"
|
||||
},
|
||||
"ListFindingsReports":{
|
||||
"name":"ListFindingsReports",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/internal/profilingGroups/{profilingGroupName}/findingsReports",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListFindingsReportsRequest"},
|
||||
"output":{"shape":"ListFindingsReportsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>List the available reports for a given profiling group and time range.</p>"
|
||||
},
|
||||
"ListProfileTimes":{
|
||||
"name":"ListProfileTimes",
|
||||
|
|
@ -131,7 +234,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>List the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.</p>"
|
||||
"documentation":"<p>Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.</p>"
|
||||
},
|
||||
"ListProfilingGroups":{
|
||||
"name":"ListProfilingGroups",
|
||||
|
|
@ -146,7 +249,7 @@
|
|||
{"shape":"InternalServerException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Lists profiling groups.</p>"
|
||||
"documentation":"<p> Returns a list of profiling groups. The profiling groups are returned as <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> objects. </p>"
|
||||
},
|
||||
"PostAgentProfile":{
|
||||
"name":"PostAgentProfile",
|
||||
|
|
@ -163,7 +266,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_GetProfile.html\"> <code>GetProfile</code> </a>. </p>"
|
||||
},
|
||||
"PutPermission":{
|
||||
"name":"PutPermission",
|
||||
|
|
@ -181,7 +284,25 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Provides permission to the principals. This overwrites the existing permissions, and is not additive.</p>",
|
||||
"documentation":"<p> Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the <code>principals</code> parameter. </p> <pre><code> <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p> </code></pre>",
|
||||
"idempotent":true
|
||||
},
|
||||
"RemoveNotificationChannel":{
|
||||
"name":"RemoveNotificationChannel",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/profilingGroups/{profilingGroupName}/notificationConfiguration/{channelId}",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"RemoveNotificationChannelRequest"},
|
||||
"output":{"shape":"RemoveNotificationChannelResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Remove one anomaly notifications channel for a profiling group.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"RemovePermission":{
|
||||
|
|
@ -200,7 +321,24 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Removes statement for the provided action group from the policy.</p>"
|
||||
"documentation":"<p> Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html\">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html\"> <code>ConfigureAgent</code> </a>, and <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html\"> <code>PostAgentProfile</code> </a>. </p>"
|
||||
},
|
||||
"SubmitFeedback":{
|
||||
"name":"SubmitFeedback",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/internal/profilingGroups/{profilingGroupName}/anomalies/{anomalyInstanceId}/feedback",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"SubmitFeedbackRequest"},
|
||||
"output":{"shape":"SubmitFeedbackResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.</p>"
|
||||
},
|
||||
"UpdateProfilingGroup":{
|
||||
"name":"UpdateProfilingGroup",
|
||||
|
|
@ -227,6 +365,36 @@
|
|||
"type":"string",
|
||||
"enum":["agentPermissions"]
|
||||
},
|
||||
"AddNotificationChannelsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"channels",
|
||||
"profilingGroupName"
|
||||
],
|
||||
"members":{
|
||||
"channels":{
|
||||
"shape":"Channels",
|
||||
"documentation":"<p>One or 2 channels to report to when anomalies are detected.</p>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group that we are setting up notifications for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the AddNotificationChannelsRequest.</p>"
|
||||
},
|
||||
"AddNotificationChannelsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"notificationConfiguration":{
|
||||
"shape":"NotificationConfiguration",
|
||||
"documentation":"<p>The new notification configuration for this profiling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the AddNotificationChannelsResponse.</p>"
|
||||
},
|
||||
"AgentConfiguration":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -234,16 +402,20 @@
|
|||
"shouldProfile"
|
||||
],
|
||||
"members":{
|
||||
"agentParameters":{
|
||||
"shape":"AgentParameters",
|
||||
"documentation":"<p> Parameters used by the profiler. The valid parameters are: </p> <ul> <li> <p> <code>MaxStackDepth</code> - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method <code>A</code>, which calls method <code>B</code>, which calls method <code>C</code>, which calls method <code>D</code>, then the depth is 4. If the <code>maxDepth</code> is set to 2, then the profiler evaluates <code>A</code> and <code>B</code>. </p> </li> <li> <p> <code>MemoryUsageLimitPercent</code> - The percentage of memory that is used by the profiler.</p> </li> <li> <p> <code>MinimumTimeForReportingInMilliseconds</code> - The minimum time in milliseconds between sending reports. </p> </li> <li> <p> <code>ReportingIntervalInMilliseconds</code> - The reporting interval in milliseconds used to report profiles. </p> </li> <li> <p> <code>SamplingIntervalInMilliseconds</code> - The sampling interval in milliseconds that is used to profile samples. </p> </li> </ul>"
|
||||
},
|
||||
"periodInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> How long a profiling agent should send profiling data using <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html\"> <code>ConfigureAgent</code> </a>. For example, if this is set to 300, the profiling agent calls <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html\"> <code>ConfigureAgent</code> </a> every 5 minutes to submit the profiled data collected during that period. </p>"
|
||||
},
|
||||
"shouldProfile":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> A <code>Boolean</code> that specifies whether the profiling agent collects profiling data or not. Set to <code>true</code> to enable profiling. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> The response of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html\"> <code>ConfigureAgent</code> </a> that specifies if an agent profiles or not and for how long to return profiling data. </p>"
|
||||
},
|
||||
"AgentOrchestrationConfig":{
|
||||
"type":"structure",
|
||||
|
|
@ -251,10 +423,25 @@
|
|||
"members":{
|
||||
"profilingEnabled":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> A <code>Boolean</code> that specifies whether the profiling agent collects profiling data or not. Set to <code>true</code> to enable profiling. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> Specifies whether profiling is enabled or disabled for a profiling group. It is used by <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html\"> <code>ConfigureAgent</code> </a> to enable or disable profiling for a profiling group. </p>"
|
||||
},
|
||||
"AgentParameterField":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"MaxStackDepth",
|
||||
"MemoryUsageLimitPercent",
|
||||
"MinimumTimeForReportingInMilliseconds",
|
||||
"ReportingIntervalInMilliseconds",
|
||||
"SamplingIntervalInMilliseconds"
|
||||
]
|
||||
},
|
||||
"AgentParameters":{
|
||||
"type":"map",
|
||||
"key":{"shape":"AgentParameterField"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"AgentProfile":{"type":"blob"},
|
||||
"AggregatedProfile":{"type":"blob"},
|
||||
|
|
@ -263,14 +450,14 @@
|
|||
"members":{
|
||||
"period":{
|
||||
"shape":"AggregationPeriod",
|
||||
"documentation":"<p>The time period.</p>"
|
||||
"documentation":"<p> The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format. </p> <ul> <li> <p> <code>P1D</code> — 1 day </p> </li> <li> <p> <code>PT1H</code> — 1 hour </p> </li> <li> <p> <code>PT5M</code> — 5 minutes </p> </li> </ul>"
|
||||
},
|
||||
"start":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time.</p>"
|
||||
"documentation":"<p> The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the <code>period</code> property of the <code>AggregatedProfileTime</code> object. </p> <p> Specify <code>start</code> using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the time range of the latest available aggregated profile.</p>"
|
||||
"documentation":"<p> Specifies the aggregation period and aggregation start time for an aggregated profile. An aggregated profile is used to collect posted agent profiles during an aggregation period. There are three possible aggregation periods (1 day, 1 hour, or 5 minutes). </p>"
|
||||
},
|
||||
"AggregationPeriod":{
|
||||
"type":"string",
|
||||
|
|
@ -280,27 +467,214 @@
|
|||
"PT5M"
|
||||
]
|
||||
},
|
||||
"Anomalies":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Anomaly"}
|
||||
},
|
||||
"Anomaly":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"instances",
|
||||
"metric",
|
||||
"reason"
|
||||
],
|
||||
"members":{
|
||||
"instances":{
|
||||
"shape":"AnomalyInstances",
|
||||
"documentation":"<p> A list of the instances of the detected anomalies during the requested period. </p>"
|
||||
},
|
||||
"metric":{
|
||||
"shape":"Metric",
|
||||
"documentation":"<p> Details about the metric that the analysis used when it detected the anomaly. The metric includes the name of the frame that was analyzed with the type and thread states used to derive the metric value for that frame. </p>"
|
||||
},
|
||||
"reason":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The reason for which metric was flagged as anomalous.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Details about an anomaly in a specific metric of application profile. The anomaly is detected using analysis of the metric data over a period of time. </p>"
|
||||
},
|
||||
"AnomalyInstance":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"id",
|
||||
"startTime"
|
||||
],
|
||||
"members":{
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"id":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The universally unique identifier (UUID) of an instance of an anomaly in a metric. </p>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The start time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"userFeedback":{
|
||||
"shape":"UserFeedback",
|
||||
"documentation":"<p>Feedback type on a specific instance of anomaly submitted by the user.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The specific duration in which the metric is flagged as anomalous.</p>"
|
||||
},
|
||||
"AnomalyInstanceId":{
|
||||
"type":"string",
|
||||
"pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
|
||||
},
|
||||
"AnomalyInstances":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AnomalyInstance"}
|
||||
},
|
||||
"BatchGetFrameMetricDataRequest":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroupName"],
|
||||
"members":{
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endTime"
|
||||
},
|
||||
"frameMetrics":{
|
||||
"shape":"FrameMetrics",
|
||||
"documentation":"<p> The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.</p>"
|
||||
},
|
||||
"period":{
|
||||
"shape":"Period",
|
||||
"documentation":"<p> The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (<code>PT24H</code> or <code>P1D</code>). </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"period"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p> The name of the profiling group associated with the the frame metrics used to return the time series values. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
},
|
||||
"targetResolution":{
|
||||
"shape":"AggregationPeriod",
|
||||
"documentation":"<p>The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values. </p> <ul> <li> <p> <code>P1D</code> — 1 day </p> </li> <li> <p> <code>PT1H</code> — 1 hour </p> </li> <li> <p> <code>PT5M</code> — 5 minutes </p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"targetResolution"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the BatchGetFrameMetricDataRequest.</p>"
|
||||
},
|
||||
"BatchGetFrameMetricDataResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"endTime",
|
||||
"endTimes",
|
||||
"frameMetricData",
|
||||
"resolution",
|
||||
"startTime",
|
||||
"unprocessedEndTimes"
|
||||
],
|
||||
"members":{
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"endTimes":{
|
||||
"shape":"ListOfTimestamps",
|
||||
"documentation":"<p> List of instances, or time steps, in the time series. For example, if the <code>period</code> is one day (<code>PT24H)</code>), and the <code>resolution</code> is five minutes (<code>PT5M</code>), then there are 288 <code>endTimes</code> in the list that are each five minutes appart. </p>"
|
||||
},
|
||||
"frameMetricData":{
|
||||
"shape":"FrameMetricData",
|
||||
"documentation":"<p>Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.</p>"
|
||||
},
|
||||
"resolution":{
|
||||
"shape":"AggregationPeriod",
|
||||
"documentation":"<p>Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values. </p> <ul> <li> <p> <code>P1D</code> — 1 day </p> </li> <li> <p> <code>PT1H</code> — 1 hour </p> </li> <li> <p> <code>PT5M</code> — 5 minutes </p> </li> </ul>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"unprocessedEndTimes":{
|
||||
"shape":"UnprocessedEndTimeMap",
|
||||
"documentation":"<p>List of instances which remained unprocessed. This will create a missing time step in the list of end times.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the BatchGetFrameMetricDataResponse.</p>"
|
||||
},
|
||||
"Boolean":{
|
||||
"type":"boolean",
|
||||
"box":true
|
||||
},
|
||||
"Channel":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"eventPublishers",
|
||||
"uri"
|
||||
],
|
||||
"members":{
|
||||
"eventPublishers":{
|
||||
"shape":"EventPublishers",
|
||||
"documentation":"<p>List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.</p>"
|
||||
},
|
||||
"id":{
|
||||
"shape":"ChannelId",
|
||||
"documentation":"<p>Unique identifier for each <code>Channel</code> in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.</p>"
|
||||
},
|
||||
"uri":{
|
||||
"shape":"ChannelUri",
|
||||
"documentation":"<p>Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.</p>"
|
||||
},
|
||||
"ChannelId":{
|
||||
"type":"string",
|
||||
"pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
|
||||
},
|
||||
"ChannelUri":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Channel URI uniquely identifies a Notification Channel. TopicArn is the uri for an SNS channel, emailId is uri for an email channel etc. Currently we only support SNS channels and thus required to be an ARN</p>"
|
||||
},
|
||||
"Channels":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Channel"},
|
||||
"max":2,
|
||||
"min":1
|
||||
},
|
||||
"ClientToken":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"^[\\w-]+$"
|
||||
},
|
||||
"ComputePlatform":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"AWSLambda",
|
||||
"Default"
|
||||
]
|
||||
},
|
||||
"ConfigureAgentRequest":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroupName"],
|
||||
"members":{
|
||||
"fleetInstanceId":{
|
||||
"shape":"FleetInstanceId",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID. </p>"
|
||||
},
|
||||
"metadata":{
|
||||
"shape":"Metadata",
|
||||
"documentation":"<p> Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:</p> <ul> <li> <p> <code>COMPUTE_PLATFORM</code> - The compute platform on which the agent is running </p> </li> <li> <p> <code>AGENT_ID</code> - The ID for an agent instance. </p> </li> <li> <p> <code>AWS_REQUEST_ID</code> - The AWS request ID of a Lambda invocation. </p> </li> <li> <p> <code>EXECUTION_ENVIRONMENT</code> - The execution environment a Lambda function is running on. </p> </li> <li> <p> <code>LAMBDA_FUNCTION_ARN</code> - The Amazon Resource Name (ARN) that is used to invoke a Lambda function. </p> </li> <li> <p> <code>LAMBDA_MEMORY_LIMIT_IN_MB</code> - The memory allocated to a Lambda function. </p> </li> <li> <p> <code>LAMBDA_REMAINING_TIME_IN_MILLISECONDS</code> - The time in milliseconds before execution of a Lambda function times out. </p> </li> <li> <p> <code>LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS</code> - The time in milliseconds between two invocations of a Lambda function. </p> </li> <li> <p> <code>LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS</code> - The time in milliseconds for the previous Lambda invocation. </p> </li> </ul>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p/>",
|
||||
"documentation":"<p> The name of the profiling group for which the configured agent is collecting profiling data. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
|
|
@ -313,7 +687,7 @@
|
|||
"members":{
|
||||
"configuration":{
|
||||
"shape":"AgentConfiguration",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> An <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html\"> <code>AgentConfiguration</code> </a> object that specifies if an agent profiles or not and for how long to return profiling data. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the configureAgentResponse.</p>",
|
||||
|
|
@ -341,18 +715,22 @@
|
|||
"members":{
|
||||
"agentOrchestrationConfig":{
|
||||
"shape":"AgentOrchestrationConfig",
|
||||
"documentation":"<p>The agent orchestration configuration.</p>"
|
||||
"documentation":"<p> Specifies whether profiling is enabled or disabled for the created profiling group. </p>"
|
||||
},
|
||||
"clientToken":{
|
||||
"shape":"ClientToken",
|
||||
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p> <p>This parameter specifies a unique identifier for the new profiling group that helps ensure idempotency.</p>",
|
||||
"documentation":"<p> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries. </p>",
|
||||
"idempotencyToken":true,
|
||||
"location":"querystring",
|
||||
"locationName":"clientToken"
|
||||
},
|
||||
"computePlatform":{
|
||||
"shape":"ComputePlatform",
|
||||
"documentation":"<p> The compute platform of the profiling group. Use <code>AWSLambda</code> if your application runs on AWS Lambda. Use <code>Default</code> if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, <code>Default</code> is used. </p>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group.</p>"
|
||||
"documentation":"<p>The name of the profiling group to create.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the createProfiliingGroupRequest.</p>"
|
||||
|
|
@ -363,7 +741,7 @@
|
|||
"members":{
|
||||
"profilingGroup":{
|
||||
"shape":"ProfilingGroupDescription",
|
||||
"documentation":"<p>Information about the new profiling group</p>"
|
||||
"documentation":"<p> The returned <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> object that contains information about the created profiling group. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the createProfilingGroupResponse.</p>",
|
||||
|
|
@ -375,7 +753,7 @@
|
|||
"members":{
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The profiling group name to delete.</p>",
|
||||
"documentation":"<p>The name of the profiling group to delete.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
|
|
@ -394,7 +772,7 @@
|
|||
"members":{
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The profiling group name.</p>",
|
||||
"documentation":"<p> The name of the profiling group to get information about. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
|
|
@ -407,18 +785,186 @@
|
|||
"members":{
|
||||
"profilingGroup":{
|
||||
"shape":"ProfilingGroupDescription",
|
||||
"documentation":"<p>Information about a profiling group.</p>"
|
||||
"documentation":"<p> The returned <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> object that contains information about the requested profiling group. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the describeProfilingGroupResponse.</p>",
|
||||
"payload":"profilingGroup"
|
||||
},
|
||||
"Double":{
|
||||
"type":"double",
|
||||
"box":true
|
||||
},
|
||||
"EventPublisher":{
|
||||
"type":"string",
|
||||
"enum":["AnomalyDetection"]
|
||||
},
|
||||
"EventPublishers":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EventPublisher"},
|
||||
"max":1,
|
||||
"min":1
|
||||
},
|
||||
"FeedbackType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Negative",
|
||||
"Positive"
|
||||
]
|
||||
},
|
||||
"FindingsReportId":{
|
||||
"type":"string",
|
||||
"pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
|
||||
},
|
||||
"FindingsReportSummaries":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FindingsReportSummary"}
|
||||
},
|
||||
"FindingsReportSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"id":{
|
||||
"shape":"FindingsReportId",
|
||||
"documentation":"<p>The universally unique identifier (UUID) of the recommendation report.</p>"
|
||||
},
|
||||
"profileEndTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"profileStartTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the profiling group that is associated with the analysis data.</p>"
|
||||
},
|
||||
"totalNumberOfFindings":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The total number of different recommendations that were found by the analysis.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Information about potential recommendations that might be created from the analysis of profiling data. </p>"
|
||||
},
|
||||
"FleetInstanceId":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"^[\\w-.:/]+$"
|
||||
},
|
||||
"FrameMetric":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"frameName",
|
||||
"threadStates",
|
||||
"type"
|
||||
],
|
||||
"members":{
|
||||
"frameName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> Name of the method common across the multiple occurrences of a frame in an application profile.</p>"
|
||||
},
|
||||
"threadStates":{
|
||||
"shape":"ThreadStates",
|
||||
"documentation":"<p>List of application runtime thread states used to get the counts for a frame a derive a metric value.</p>"
|
||||
},
|
||||
"type":{
|
||||
"shape":"MetricType",
|
||||
"documentation":"<p> A type of aggregation that specifies how a metric for a frame is analyzed. The supported value <code>AggregatedRelativeTotalTime</code> is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.</p>"
|
||||
},
|
||||
"FrameMetricData":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FrameMetricDatum"}
|
||||
},
|
||||
"FrameMetricDatum":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"frameMetric",
|
||||
"values"
|
||||
],
|
||||
"members":{
|
||||
"frameMetric":{"shape":"FrameMetric"},
|
||||
"values":{
|
||||
"shape":"FrameMetricValues",
|
||||
"documentation":"<p> A list of values that are associated with a frame metric. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Information about a frame metric and its values. </p>"
|
||||
},
|
||||
"FrameMetricValues":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Double"}
|
||||
},
|
||||
"FrameMetrics":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FrameMetric"}
|
||||
},
|
||||
"GetFindingsReportAccountSummaryRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"dailyReportsOnly":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>, analysis data is returned from smaller time windows (for example, one hour).</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"dailyReportsOnly"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results returned by <code> GetFindingsReportAccountSummary</code> in paginated output. When this parameter is used, <code>GetFindingsReportAccountSummary</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>GetFindingsReportAccountSummary</code> request with the returned <code>nextToken</code> value.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>GetFindingsReportAccountSummary</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the GetFindingsReportAccountSummaryRequest.</p>"
|
||||
},
|
||||
"GetFindingsReportAccountSummaryResponse":{
|
||||
"type":"structure",
|
||||
"required":["reportSummaries"],
|
||||
"members":{
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>GetFindingsReportAccountSummary</code> request. When the results of a <code>GetFindingsReportAccountSummary</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
|
||||
},
|
||||
"reportSummaries":{
|
||||
"shape":"FindingsReportSummaries",
|
||||
"documentation":"<p>The return list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_FindingsReportSummary.html\"> <code>FindingsReportSummary</code> </a> objects taht contain summaries of analysis results for all profiling groups in your AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the GetFindingsReportAccountSummaryResponse.</p>"
|
||||
},
|
||||
"GetNotificationConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroupName"],
|
||||
"members":{
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group we want to get the notification configuration for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the GetNotificationConfigurationRequest.</p>"
|
||||
},
|
||||
"GetNotificationConfigurationResponse":{
|
||||
"type":"structure",
|
||||
"required":["notificationConfiguration"],
|
||||
"members":{
|
||||
"notificationConfiguration":{
|
||||
"shape":"NotificationConfiguration",
|
||||
"documentation":"<p>The current notification configuration for this profiling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the GetNotificationConfigurationResponse.</p>"
|
||||
},
|
||||
"GetPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":["profilingGroupName"],
|
||||
|
|
@ -430,7 +976,7 @@
|
|||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the getPolicyRequest.</p>"
|
||||
"documentation":"<p> The structure representing the <code>getPolicyRequest</code>. </p>"
|
||||
},
|
||||
"GetPolicyResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -441,14 +987,14 @@
|
|||
"members":{
|
||||
"policy":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The resource-based policy attached to the <code>ProfilingGroup</code>.</p>"
|
||||
"documentation":"<p>The JSON-formatted resource-based policy attached to the <code>ProfilingGroup</code>.</p>"
|
||||
},
|
||||
"revisionId":{
|
||||
"shape":"RevisionId",
|
||||
"documentation":"<p>A unique identifier for the current revision of the policy.</p>"
|
||||
"documentation":"<p>A unique identifier for the current revision of the returned policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the getPolicyResponse.</p>"
|
||||
"documentation":"<p>The structure representing the <code>getPolicyResponse</code>.</p>"
|
||||
},
|
||||
"GetProfileRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -456,25 +1002,25 @@
|
|||
"members":{
|
||||
"accept":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The format of the profile to return. You can choose <code>application/json</code> or the default <code>application/x-amzn-ion</code>. </p>",
|
||||
"documentation":"<p> The format of the returned profiling data. The format maps to the <code>Accept</code> and <code>Content-Type</code> headers of the HTTP request. You can specify one of the following: or the default . </p> <pre><code> <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul> </code></pre>",
|
||||
"location":"header",
|
||||
"locationName":"Accept"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p/> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>",
|
||||
"documentation":"<p> The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p> <p> If you specify <code>endTime</code>, then you must also specify <code>period</code> or <code>startTime</code>, but not both. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endTime"
|
||||
},
|
||||
"maxDepth":{
|
||||
"shape":"MaxDepth",
|
||||
"documentation":"<p>The maximum depth of the graph.</p>",
|
||||
"documentation":"<p> The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method <code>A</code>, which calls method <code>B</code>, which calls method <code>C</code>, which calls method <code>D</code>, then the depth is 4. If the <code>maxDepth</code> is set to 2, then the aggregated profile contains representations of methods <code>A</code> and <code>B</code>. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxDepth"
|
||||
},
|
||||
"period":{
|
||||
"shape":"Period",
|
||||
"documentation":"<p>The period of the profile to get. The time range must be in the past and not longer than one week. </p> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>",
|
||||
"documentation":"<p> Used with <code>startTime</code> or <code>endTime</code> to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, <code>P1DT1H1M1S</code>. </p> <pre><code> <p> To get the latest aggregated profile, specify only <code>period</code>. </p> </code></pre>",
|
||||
"location":"querystring",
|
||||
"locationName":"period"
|
||||
},
|
||||
|
|
@ -486,7 +1032,7 @@
|
|||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time of the profile to get.</p> <p>You must specify exactly two of the following parameters: <code>startTime</code>, <code>period</code>, and <code>endTime</code>. </p>",
|
||||
"documentation":"<p>The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p> <pre><code> <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p> </code></pre>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
}
|
||||
|
|
@ -520,6 +1066,74 @@
|
|||
"documentation":"<p>The structure representing the getProfileResponse.</p>",
|
||||
"payload":"profile"
|
||||
},
|
||||
"GetRecommendationsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"endTime",
|
||||
"profilingGroupName",
|
||||
"startTime"
|
||||
],
|
||||
"members":{
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endTime"
|
||||
},
|
||||
"locale":{
|
||||
"shape":"Locale",
|
||||
"documentation":"<p> The language used to provide analysis. Specify using a string that is one of the following <code>BCP 47</code> language codes. </p> <ul> <li> <p> <code>de-DE</code> - German, Germany </p> </li> <li> <p> <code>en-GB</code> - English, United Kingdom </p> </li> <li> <p> <code>en-US</code> - English, United States </p> </li> <li> <p> <code>es-ES</code> - Spanish, Spain </p> </li> <li> <p> <code>fr-FR</code> - French, France </p> </li> <li> <p> <code>it-IT</code> - Italian, Italy </p> </li> <li> <p> <code>ja-JP</code> - Japanese, Japan </p> </li> <li> <p> <code>ko-KR</code> - Korean, Republic of Korea </p> </li> <li> <p> <code>pt-BR</code> - Portugese, Brazil </p> </li> <li> <p> <code>zh-CN</code> - Chinese, China </p> </li> <li> <p> <code>zh-TW</code> - Chinese, Taiwan </p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"locale"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p> The name of the profiling group to get analysis data about. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the GetRecommendationsRequest.</p>"
|
||||
},
|
||||
"GetRecommendationsResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"anomalies",
|
||||
"profileEndTime",
|
||||
"profileStartTime",
|
||||
"profilingGroupName",
|
||||
"recommendations"
|
||||
],
|
||||
"members":{
|
||||
"anomalies":{
|
||||
"shape":"Anomalies",
|
||||
"documentation":"<p> The list of anomalies that the analysis has found for this profile. </p>"
|
||||
},
|
||||
"profileEndTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The end time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"profileStartTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group the analysis data is about.</p>"
|
||||
},
|
||||
"recommendations":{
|
||||
"shape":"Recommendations",
|
||||
"documentation":"<p>The list of recommendations that the analysis found for this profile.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the GetRecommendationsResponse.</p>"
|
||||
},
|
||||
"Integer":{
|
||||
"type":"integer",
|
||||
"box":true
|
||||
|
|
@ -535,6 +1149,72 @@
|
|||
"exception":true,
|
||||
"fault":true
|
||||
},
|
||||
"ListFindingsReportsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"endTime",
|
||||
"profilingGroupName",
|
||||
"startTime"
|
||||
],
|
||||
"members":{
|
||||
"dailyReportsOnly":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>A <code>Boolean</code> value indicating whether to only return reports from daily profiles. If set to <code>True</code>, only analysis data from daily profiles is returned. If set to <code>False</code>, analysis data is returned from smaller time windows (for example, one hour).</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"dailyReportsOnly"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The end time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"endTime"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of report results returned by <code>ListFindingsReports</code> in paginated output. When this parameter is used, <code>ListFindingsReports</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListFindingsReports</code> request with the returned <code>nextToken</code> value.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListFindingsReportsRequest</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group from which to search for analysis data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> The start time of the profile to get analysis data about. You must specify <code>startTime</code> and <code>endTime</code>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"startTime"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the ListFindingsReportsRequest.</p>"
|
||||
},
|
||||
"ListFindingsReportsResponse":{
|
||||
"type":"structure",
|
||||
"required":["findingsReportSummaries"],
|
||||
"members":{
|
||||
"findingsReportSummaries":{
|
||||
"shape":"FindingsReportSummaries",
|
||||
"documentation":"<p>The list of analysis results summaries.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListFindingsReports</code> request. When the results of a <code>ListFindingsReports</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the ListFindingsReportsResponse.</p>"
|
||||
},
|
||||
"ListOfTimestamps":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TimestampStructure"}
|
||||
},
|
||||
"ListProfileTimesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -570,7 +1250,7 @@
|
|||
},
|
||||
"period":{
|
||||
"shape":"AggregationPeriod",
|
||||
"documentation":"<p>The aggregation period.</p>",
|
||||
"documentation":"<p> The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values. </p> <ul> <li> <p> <code>P1D</code> — 1 day </p> </li> <li> <p> <code>PT1H</code> — 1 hour </p> </li> <li> <p> <code>PT5M</code> — 5 minutes </p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"period"
|
||||
},
|
||||
|
|
@ -609,7 +1289,7 @@
|
|||
"members":{
|
||||
"includeDescription":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>A Boolean value indicating whether to include a description.</p>",
|
||||
"documentation":"<p>A <code>Boolean</code> value indicating whether to include a description. If <code>true</code>, then a list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> objects that contain detailed information about profiling groups is returned. If <code>false</code>, then a list of profiling group names is returned.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"includeDescription"
|
||||
},
|
||||
|
|
@ -638,15 +1318,41 @@
|
|||
},
|
||||
"profilingGroupNames":{
|
||||
"shape":"ProfilingGroupNames",
|
||||
"documentation":"<p>Information about profiling group names.</p>"
|
||||
"documentation":"<p> A returned list of profiling group names. A list of the names is returned only if <code>includeDescription</code> is <code>false</code>, otherwise a list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> objects is returned. </p>"
|
||||
},
|
||||
"profilingGroups":{
|
||||
"shape":"ProfilingGroupDescriptions",
|
||||
"documentation":"<p>Information about profiling groups.</p>"
|
||||
"documentation":"<p> A returned list <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> objects. A list of <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> objects is returned only if <code>includeDescription</code> is <code>true</code>, otherwise a list of profiling group names is returned. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the listProfilingGroupsResponse.</p>"
|
||||
},
|
||||
"Locale":{
|
||||
"type":"string",
|
||||
"documentation":"<p>BCP47 language code. Supported locales: de-DE, en-GB, en-US, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, zh-CN, zh-TW</p>"
|
||||
},
|
||||
"Match":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"frameAddress":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The location in the profiling graph that contains a recommendation found during analysis.</p>"
|
||||
},
|
||||
"targetFramesIndex":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The target frame that triggered a match.</p>"
|
||||
},
|
||||
"thresholdBreachValue":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>The value in the profile data that exceeded the recommendation threshold.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The part of a profile that contains a recommendation found during analysis.</p>"
|
||||
},
|
||||
"Matches":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Match"}
|
||||
},
|
||||
"MaxDepth":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
|
|
@ -659,6 +1365,62 @@
|
|||
"max":1000,
|
||||
"min":1
|
||||
},
|
||||
"Metadata":{
|
||||
"type":"map",
|
||||
"key":{"shape":"MetadataField"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"MetadataField":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"AgentId",
|
||||
"AwsRequestId",
|
||||
"ComputePlatform",
|
||||
"ExecutionEnvironment",
|
||||
"LambdaFunctionArn",
|
||||
"LambdaMemoryLimitInMB",
|
||||
"LambdaPreviousExecutionTimeInMilliseconds",
|
||||
"LambdaRemainingTimeInMilliseconds",
|
||||
"LambdaTimeGapBetweenInvokesInMilliseconds"
|
||||
]
|
||||
},
|
||||
"Metric":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"frameName",
|
||||
"threadStates",
|
||||
"type"
|
||||
],
|
||||
"members":{
|
||||
"frameName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The name of the method that appears as a frame in any stack in a profile. </p>"
|
||||
},
|
||||
"threadStates":{
|
||||
"shape":"Strings",
|
||||
"documentation":"<p> The list of application runtime thread states that is used to calculate the metric value for the frame. </p>"
|
||||
},
|
||||
"type":{
|
||||
"shape":"MetricType",
|
||||
"documentation":"<p> A type that specifies how a metric for a frame is analyzed. The supported value <code>AggregatedRelativeTotalTime</code> is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame. </p>"
|
||||
},
|
||||
"MetricType":{
|
||||
"type":"string",
|
||||
"enum":["AggregatedRelativeTotalTime"]
|
||||
},
|
||||
"NotificationConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"channels":{
|
||||
"shape":"Channels",
|
||||
"documentation":"<p>List of up to two channels to be used for sending notifications for events detected from the application profile.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration for notifications stored for each profiling group. This includes up to to two channels and a list of event publishers associated with each channel.</p>"
|
||||
},
|
||||
"OrderBy":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -672,6 +1434,45 @@
|
|||
"min":1,
|
||||
"pattern":"^[\\w-]+$"
|
||||
},
|
||||
"Pattern":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"countersToAggregate":{
|
||||
"shape":"Strings",
|
||||
"documentation":"<p> A list of the different counters used to determine if there is a match. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The description of the recommendation. This explains a potential inefficiency in a profiled application.</p>"
|
||||
},
|
||||
"id":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The universally unique identifier (UUID) of this pattern.</p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name for this pattern.</p>"
|
||||
},
|
||||
"resolutionSteps":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> A string that contains the steps recommended to address the potential inefficiency. </p>"
|
||||
},
|
||||
"targetFrames":{
|
||||
"shape":"TargetFrames",
|
||||
"documentation":"<p>A list of frame names that were searched during the analysis that generated a recommendation.</p>"
|
||||
},
|
||||
"thresholdPercent":{
|
||||
"shape":"Percentage",
|
||||
"documentation":"<p> The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A set of rules used to make a recommendation during an analysis. </p>"
|
||||
},
|
||||
"Percentage":{
|
||||
"type":"double",
|
||||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"Period":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
|
|
@ -687,24 +1488,24 @@
|
|||
"members":{
|
||||
"agentProfile":{
|
||||
"shape":"AgentProfile",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> The submitted profiling data. </p>"
|
||||
},
|
||||
"contentType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p/>",
|
||||
"documentation":"<p> The format of the submitted profiling data. The format maps to the <code>Accept</code> and <code>Content-Type</code> headers of the HTTP request. You can specify one of the following: or the default . </p> <pre><code> <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul> </code></pre>",
|
||||
"location":"header",
|
||||
"locationName":"Content-Type"
|
||||
},
|
||||
"profileToken":{
|
||||
"shape":"ClientToken",
|
||||
"documentation":"<p/>",
|
||||
"documentation":"<p> Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries. </p>",
|
||||
"idempotencyToken":true,
|
||||
"location":"querystring",
|
||||
"locationName":"profileToken"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p/>",
|
||||
"documentation":"<p> The name of the profiling group with the aggregated profile that receives the submitted profiling data. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
|
|
@ -730,10 +1531,10 @@
|
|||
"members":{
|
||||
"start":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time of the profile.</p>"
|
||||
"documentation":"<p>The start time of a profile. It is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the profile time.</p>"
|
||||
"documentation":"<p> Contains the start time of a profile. </p>"
|
||||
},
|
||||
"ProfileTimes":{
|
||||
"type":"list",
|
||||
|
|
@ -745,15 +1546,19 @@
|
|||
"members":{
|
||||
"agentOrchestrationConfig":{
|
||||
"shape":"AgentOrchestrationConfig",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> An <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html\"> <code>AgentOrchestrationConfig</code> </a> object that indicates if the profiling group is enabled for profiled or not. </p>"
|
||||
},
|
||||
"arn":{
|
||||
"shape":"ProfilingGroupArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) identifying the profiling group.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) identifying the profiling group resource.</p>"
|
||||
},
|
||||
"computePlatform":{
|
||||
"shape":"ComputePlatform",
|
||||
"documentation":"<p> The compute platform of the profiling group. If it is set to <code>AWSLambda</code>, then the profiled application runs on AWS Lambda. If it is set to <code>Default</code>, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is <code>Default</code>. </p>"
|
||||
},
|
||||
"createdAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the profiling group was created.</p>"
|
||||
"documentation":"<p>The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"ProfilingGroupName",
|
||||
|
|
@ -761,14 +1566,14 @@
|
|||
},
|
||||
"profilingStatus":{
|
||||
"shape":"ProfilingStatus",
|
||||
"documentation":"<p>The status of the profiling group.</p>"
|
||||
"documentation":"<p> A <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html\"> <code>ProfilingStatus</code> </a> object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile. </p>"
|
||||
},
|
||||
"updatedAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the profiling group was last updated.</p>"
|
||||
"documentation":"<p> The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The description of a profiling group.</p>"
|
||||
"documentation":"<p> Contains information about a profiling group. </p>"
|
||||
},
|
||||
"ProfilingGroupDescriptions":{
|
||||
"type":"list",
|
||||
|
|
@ -789,18 +1594,18 @@
|
|||
"members":{
|
||||
"latestAgentOrchestratedAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the latest agent was orchestrated.</p>"
|
||||
"documentation":"<p>The date and time when the profiling agent most recently pinged back. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>"
|
||||
},
|
||||
"latestAgentProfileReportedAt":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time, in milliseconds since the epoch, when the latest agent was reported..</p>"
|
||||
"documentation":"<p>The date and time when the most recent profile was received. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>"
|
||||
},
|
||||
"latestAggregatedProfile":{
|
||||
"shape":"AggregatedProfileTime",
|
||||
"documentation":"<p>The latest aggregated profile</p>"
|
||||
"documentation":"<p> An <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html\"> <code>AggregatedProfileTime</code> </a> object that contains the aggregation period and start time for an aggregated profile. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the profiling status.</p>"
|
||||
"documentation":"<p> Profiling status includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile. </p>"
|
||||
},
|
||||
"PutPermissionRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -812,26 +1617,26 @@
|
|||
"members":{
|
||||
"actionGroup":{
|
||||
"shape":"ActionGroup",
|
||||
"documentation":"<p>The list of actions that the users and roles can perform on the profiling group.</p>",
|
||||
"documentation":"<p> Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, <code>agentPermissions</code>, which grants permission to perform actions required by the profiling agent, <code>ConfigureAgent</code> and <code>PostAgentProfile</code> permissions. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"actionGroup"
|
||||
},
|
||||
"principals":{
|
||||
"shape":"Principals",
|
||||
"documentation":"<p>The list of role and user ARNs or the accountId that needs access (wildcards are not allowed).</p>"
|
||||
"documentation":"<p> A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs. </p>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group.</p>",
|
||||
"documentation":"<p>The name of the profiling group to grant access to.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
},
|
||||
"revisionId":{
|
||||
"shape":"RevisionId",
|
||||
"documentation":"<p>A unique identifier for the current revision of the policy. This is required, if a policy exists for the profiling group. This is not required when creating the policy for the first time.</p>"
|
||||
"documentation":"<p> A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the <code>revisionId</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the putPermissionRequest.</p>"
|
||||
"documentation":"<p>The structure representing the <code>putPermissionRequest</code>.</p>"
|
||||
},
|
||||
"PutPermissionResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -842,14 +1647,88 @@
|
|||
"members":{
|
||||
"policy":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The resource-based policy.</p>"
|
||||
"documentation":"<p> The JSON-formatted resource-based policy on the profiling group that includes the added permissions. </p>"
|
||||
},
|
||||
"revisionId":{
|
||||
"shape":"RevisionId",
|
||||
"documentation":"<p>A unique identifier for the current revision of the policy.</p>"
|
||||
"documentation":"<p> A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the <code>policy</code> element of the response. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the putPermissionResponse.</p>"
|
||||
"documentation":"<p>The structure representing the <code>putPermissionResponse</code>.</p>"
|
||||
},
|
||||
"Recommendation":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"allMatchesCount",
|
||||
"allMatchesSum",
|
||||
"endTime",
|
||||
"pattern",
|
||||
"startTime",
|
||||
"topMatches"
|
||||
],
|
||||
"members":{
|
||||
"allMatchesCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>How many different places in the profile graph triggered a match.</p>"
|
||||
},
|
||||
"allMatchesSum":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>How much of the total sample count is potentially affected.</p>"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>End time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>"
|
||||
},
|
||||
"pattern":{
|
||||
"shape":"Pattern",
|
||||
"documentation":"<p>The pattern that analysis recognized in the profile to make this recommendation.</p>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The start time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.</p>"
|
||||
},
|
||||
"topMatches":{
|
||||
"shape":"Matches",
|
||||
"documentation":"<p>List of the matches with most impact. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A potential improvement that was found from analyzing the profiling data.</p>"
|
||||
},
|
||||
"Recommendations":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Recommendation"}
|
||||
},
|
||||
"RemoveNotificationChannelRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"channelId",
|
||||
"profilingGroupName"
|
||||
],
|
||||
"members":{
|
||||
"channelId":{
|
||||
"shape":"ChannelId",
|
||||
"documentation":"<p>The id of the channel that we want to stop receiving notifications.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"channelId"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group we want to change notification configuration for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the RemoveNotificationChannelRequest.</p>"
|
||||
},
|
||||
"RemoveNotificationChannelResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"notificationConfiguration":{
|
||||
"shape":"NotificationConfiguration",
|
||||
"documentation":"<p>The new notification configuration for this profiling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the RemoveNotificationChannelResponse.</p>"
|
||||
},
|
||||
"RemovePermissionRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -861,7 +1740,7 @@
|
|||
"members":{
|
||||
"actionGroup":{
|
||||
"shape":"ActionGroup",
|
||||
"documentation":"<p>The list of actions that the users and roles can perform on the profiling group.</p>",
|
||||
"documentation":"<p> Specifies an action group that contains the permissions to remove from a profiling group's resource-based policy. One action group is supported, <code>agentPermissions</code>, which grants <code>ConfigureAgent</code> and <code>PostAgentProfile</code> permissions. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"actionGroup"
|
||||
},
|
||||
|
|
@ -873,12 +1752,12 @@
|
|||
},
|
||||
"revisionId":{
|
||||
"shape":"RevisionId",
|
||||
"documentation":"<p>A unique identifier for the current revision of the policy.</p>",
|
||||
"documentation":"<p> A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"revisionId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the removePermissionRequest.</p>"
|
||||
"documentation":"<p> <pre><code> The structure representing the <code>removePermissionRequest</code>.</p> </code></pre>"
|
||||
},
|
||||
"RemovePermissionResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -889,14 +1768,14 @@
|
|||
"members":{
|
||||
"policy":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The resource-based policy.</p>"
|
||||
"documentation":"<p> The JSON-formatted resource-based policy on the profiling group after the specified permissions were removed. </p>"
|
||||
},
|
||||
"revisionId":{
|
||||
"shape":"RevisionId",
|
||||
"documentation":"<p>A unique identifier for the current revision of the policy.</p>"
|
||||
"documentation":"<p> A universally unique identifier (UUID) for the revision of the resource-based policy after the specified permissions were removed. The updated JSON-formatted policy is in the <code>policy</code> element of the response. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the removePermissionResponse.</p>"
|
||||
"documentation":"<p>The structure representing the <code>removePermissionResponse</code>.</p>"
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
|
|
@ -929,6 +1808,59 @@
|
|||
"exception":true
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"Strings":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SubmitFeedbackRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"anomalyInstanceId",
|
||||
"profilingGroupName",
|
||||
"type"
|
||||
],
|
||||
"members":{
|
||||
"anomalyInstanceId":{
|
||||
"shape":"AnomalyInstanceId",
|
||||
"documentation":"<p>The universally unique identifier (UUID) of the <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AnomalyInstance.html\"> <code>AnomalyInstance</code> </a> object that is included in the analysis data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"anomalyInstanceId"
|
||||
},
|
||||
"comment":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Optional feedback about this anomaly.</p>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
"documentation":"<p>The name of the profiling group that is associated with the analysis data.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"profilingGroupName"
|
||||
},
|
||||
"type":{
|
||||
"shape":"FeedbackType",
|
||||
"documentation":"<p> The feedback tpye. Thee are two valid values, <code>Positive</code> and <code>Negative</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the SubmitFeedbackRequest.</p>"
|
||||
},
|
||||
"SubmitFeedbackResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The structure representing the SubmitFeedbackResponse.</p>"
|
||||
},
|
||||
"TargetFrame":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"TargetFrames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TargetFrame"}
|
||||
},
|
||||
"ThreadStates":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"ThrottlingException":{
|
||||
"type":"structure",
|
||||
"required":["message"],
|
||||
|
|
@ -946,6 +1878,22 @@
|
|||
"type":"timestamp",
|
||||
"timestampFormat":"iso8601"
|
||||
},
|
||||
"TimestampStructure":{
|
||||
"type":"structure",
|
||||
"required":["value"],
|
||||
"members":{
|
||||
"value":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p> A <code>Timestamp</code>. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A data type that contains a <code>Timestamp</code> object. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. </p>"
|
||||
},
|
||||
"UnprocessedEndTimeMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"ListOfTimestamps"}
|
||||
},
|
||||
"UpdateProfilingGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -955,7 +1903,7 @@
|
|||
"members":{
|
||||
"agentOrchestrationConfig":{
|
||||
"shape":"AgentOrchestrationConfig",
|
||||
"documentation":"<p/>"
|
||||
"documentation":"<p> Specifies whether profiling is enabled or disabled for a profiling group. </p>"
|
||||
},
|
||||
"profilingGroupName":{
|
||||
"shape":"ProfilingGroupName",
|
||||
|
|
@ -972,12 +1920,23 @@
|
|||
"members":{
|
||||
"profilingGroup":{
|
||||
"shape":"ProfilingGroupDescription",
|
||||
"documentation":"<p>Updated information about the profiling group.</p>"
|
||||
"documentation":"<p> A <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html\"> <code>ProfilingGroupDescription</code> </a> that contains information about the returned updated profiling group. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure representing the updateProfilingGroupResponse.</p>",
|
||||
"payload":"profilingGroup"
|
||||
},
|
||||
"UserFeedback":{
|
||||
"type":"structure",
|
||||
"required":["type"],
|
||||
"members":{
|
||||
"type":{
|
||||
"shape":"FeedbackType",
|
||||
"documentation":"<p>Optional <code>Positive</code> or <code>Negative</code> feedback submitted by the user about whether the recommendation is useful or not.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Feedback that can be submitted for each instance of an anomaly by the user. Feedback is be used for improvements in generating recommendations for the application.</p>"
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"required":["message"],
|
||||
|
|
@ -992,5 +1951,5 @@
|
|||
"exception":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This section provides documentation for the Amazon CodeGuru Profiler API operations.</p>"
|
||||
"documentation":"<p>This section provides documentation for the Amazon CodeGuru Profiler API operations.</p> <pre><code> <p>Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks. </p> <p>Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. </p> <note> <p>Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages.</p> </note> <p> For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html">What is Amazon CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>. </p> </code></pre>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -22,10 +22,25 @@
|
|||
"input":{"shape":"CreateConnectionInput"},
|
||||
"output":{"shape":"CreateConnectionOutput"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"}
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceUnavailableException"}
|
||||
],
|
||||
"documentation":"<p>Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.</p>"
|
||||
},
|
||||
"CreateHost":{
|
||||
"name":"CreateHost",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateHostInput"},
|
||||
"output":{"shape":"CreateHostOutput"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.</p> <note> <p>A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.</p> </note>"
|
||||
},
|
||||
"DeleteConnection":{
|
||||
"name":"DeleteConnection",
|
||||
"http":{
|
||||
|
|
@ -39,6 +54,20 @@
|
|||
],
|
||||
"documentation":"<p>The connection to be deleted.</p>"
|
||||
},
|
||||
"DeleteHost":{
|
||||
"name":"DeleteHost",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteHostInput"},
|
||||
"output":{"shape":"DeleteHostOutput"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceUnavailableException"}
|
||||
],
|
||||
"documentation":"<p>The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.</p> <note> <p>A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.</p> </note>"
|
||||
},
|
||||
"GetConnection":{
|
||||
"name":"GetConnection",
|
||||
"http":{
|
||||
|
|
@ -48,10 +77,24 @@
|
|||
"input":{"shape":"GetConnectionInput"},
|
||||
"output":{"shape":"GetConnectionOutput"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceUnavailableException"}
|
||||
],
|
||||
"documentation":"<p>Returns the connection ARN and details such as status, owner, and provider type.</p>"
|
||||
},
|
||||
"GetHost":{
|
||||
"name":"GetHost",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetHostInput"},
|
||||
"output":{"shape":"GetHostOutput"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.</p>"
|
||||
},
|
||||
"ListConnections":{
|
||||
"name":"ListConnections",
|
||||
"http":{
|
||||
|
|
@ -62,6 +105,16 @@
|
|||
"output":{"shape":"ListConnectionsOutput"},
|
||||
"documentation":"<p>Lists the connections associated with your account.</p>"
|
||||
},
|
||||
"ListHosts":{
|
||||
"name":"ListHosts",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListHostsInput"},
|
||||
"output":{"shape":"ListHostsOutput"},
|
||||
"documentation":"<p>Lists the hosts associated with your account.</p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
|
|
@ -128,7 +181,7 @@
|
|||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
"documentation":"<p>The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.</p>"
|
||||
"documentation":"<p>The name of the external provider where your third-party code repository is configured. The valid provider type is Bitbucket.</p>"
|
||||
},
|
||||
"OwnerAccountId":{
|
||||
"shape":"AccountId",
|
||||
|
|
@ -137,9 +190,13 @@
|
|||
"ConnectionStatus":{
|
||||
"shape":"ConnectionStatus",
|
||||
"documentation":"<p>The current status of the connection. </p>"
|
||||
},
|
||||
"HostArn":{
|
||||
"shape":"HostArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the host associated with the connection.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline.</p> <p>Note: A connection created through CloudFormation is in `PENDING` status by default. You can make its status `AVAILABLE` by editing the connection in the CodePipeline console.</p>"
|
||||
"documentation":"<p>A resource that is used to connect third-party source providers with services like AWS CodePipeline.</p> <p>Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.</p>"
|
||||
},
|
||||
"ConnectionArn":{
|
||||
"type":"string",
|
||||
|
|
@ -166,14 +223,11 @@
|
|||
},
|
||||
"CreateConnectionInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ProviderType",
|
||||
"ConnectionName"
|
||||
],
|
||||
"required":["ConnectionName"],
|
||||
"members":{
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
"documentation":"<p>The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.</p>"
|
||||
"documentation":"<p>The name of the external provider where your third-party code repository is configured. The valid provider type is Bitbucket.</p>"
|
||||
},
|
||||
"ConnectionName":{
|
||||
"shape":"ConnectionName",
|
||||
|
|
@ -182,6 +236,10 @@
|
|||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The key-value pair to use when tagging the resource.</p>"
|
||||
},
|
||||
"HostArn":{
|
||||
"shape":"HostArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the host associated with the connection to be created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -199,6 +257,41 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"CreateHostInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"ProviderType",
|
||||
"ProviderEndpoint"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"HostName",
|
||||
"documentation":"<p>The name of the host to be created. The name must be unique in the calling AWS account.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
"documentation":"<p>The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.</p>"
|
||||
},
|
||||
"ProviderEndpoint":{
|
||||
"shape":"Url",
|
||||
"documentation":"<p>The endpoint of the infrastructure to be represented by the host after it is created.</p>"
|
||||
},
|
||||
"VpcConfiguration":{
|
||||
"shape":"VpcConfiguration",
|
||||
"documentation":"<p>The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateHostOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HostArn":{
|
||||
"shape":"HostArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the host to be created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteConnectionInput":{
|
||||
"type":"structure",
|
||||
"required":["ConnectionArn"],
|
||||
|
|
@ -214,6 +307,21 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteHostInput":{
|
||||
"type":"structure",
|
||||
"required":["HostArn"],
|
||||
"members":{
|
||||
"HostArn":{
|
||||
"shape":"HostArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the host to be deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteHostOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"type":"string",
|
||||
"max":600
|
||||
|
|
@ -237,6 +345,92 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetHostInput":{
|
||||
"type":"structure",
|
||||
"required":["HostArn"],
|
||||
"members":{
|
||||
"HostArn":{
|
||||
"shape":"HostArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the requested host.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetHostOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"HostName",
|
||||
"documentation":"<p>The name of the requested host.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"HostStatus",
|
||||
"documentation":"<p>The status of the requested host.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
"documentation":"<p>The provider type of the requested host, such as GitHub Enterprise Server.</p>"
|
||||
},
|
||||
"ProviderEndpoint":{
|
||||
"shape":"Url",
|
||||
"documentation":"<p>The endpoint of the infrastructure represented by the requested host.</p>"
|
||||
},
|
||||
"VpcConfiguration":{
|
||||
"shape":"VpcConfiguration",
|
||||
"documentation":"<p>The VPC configuration of the requested host.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Host":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"HostName",
|
||||
"documentation":"<p>The name of the host.</p>"
|
||||
},
|
||||
"HostArn":{
|
||||
"shape":"HostArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the host.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"ProviderType",
|
||||
"documentation":"<p>The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.</p>"
|
||||
},
|
||||
"ProviderEndpoint":{
|
||||
"shape":"Url",
|
||||
"documentation":"<p>The endpoint of the infrastructure where your provider type is installed.</p>"
|
||||
},
|
||||
"VpcConfiguration":{
|
||||
"shape":"VpcConfiguration",
|
||||
"documentation":"<p>The VPC configuration provisioned for the host.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"HostStatus",
|
||||
"documentation":"<p>The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.</p>"
|
||||
},
|
||||
"StatusMessage":{
|
||||
"shape":"HostStatusMessage",
|
||||
"documentation":"<p>The status description for the host.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.</p> <note> <p>A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.</p> </note>"
|
||||
},
|
||||
"HostArn":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+"
|
||||
},
|
||||
"HostList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Host"}
|
||||
},
|
||||
"HostName":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"min":1
|
||||
},
|
||||
"HostStatus":{"type":"string"},
|
||||
"HostStatusMessage":{"type":"string"},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -252,6 +446,10 @@
|
|||
"shape":"ProviderType",
|
||||
"documentation":"<p>Filters the list of connections to those associated with a specified provider, such as Bitbucket.</p>"
|
||||
},
|
||||
"HostArnFilter":{
|
||||
"shape":"HostArn",
|
||||
"documentation":"<p>Filters the list of connections to those associated with a specified host.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"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>"
|
||||
|
|
@ -275,6 +473,32 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListHostsInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"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>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that was returned from the previous <code>ListHosts</code> call, which can be used to return the next set of hosts in the list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListHostsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Hosts":{
|
||||
"shape":"HostList",
|
||||
"documentation":"<p>A list of hosts and the details for each host, such as status, endpoint, and provider type.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>A token that can be used in the next <code>ListHosts</code> call. To view all items in the list, continue to call this operation with each subsequent token until no more <code>nextToken</code> values are returned.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceInput":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
|
|
@ -296,7 +520,7 @@
|
|||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"max":5000,
|
||||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"NextToken":{
|
||||
|
|
@ -306,7 +530,10 @@
|
|||
},
|
||||
"ProviderType":{
|
||||
"type":"string",
|
||||
"enum":["Bitbucket"]
|
||||
"enum":[
|
||||
"Bitbucket",
|
||||
"GitHubEnterpriseServer"
|
||||
]
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
|
|
@ -316,6 +543,34 @@
|
|||
"documentation":"<p>Resource not found. Verify the connection resource ARN and try again.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ResourceUnavailableException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Resource not found. Verify the ARN for the host resource and try again.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SecurityGroupId":{
|
||||
"type":"string",
|
||||
"pattern":"sg-\\w{8}(\\w{9})?"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SecurityGroupId"},
|
||||
"max":10,
|
||||
"min":1
|
||||
},
|
||||
"SubnetId":{
|
||||
"type":"string",
|
||||
"pattern":"subnet-\\w{8}(\\w{9})?"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SubnetId"},
|
||||
"max":10,
|
||||
"min":1
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -378,6 +633,11 @@
|
|||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"TlsCertificate":{
|
||||
"type":"string",
|
||||
"max":16384,
|
||||
"min":1
|
||||
},
|
||||
"UntagResourceInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -399,7 +659,43 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Url":{
|
||||
"type":"string",
|
||||
"max":512,
|
||||
"min":1
|
||||
},
|
||||
"VpcConfiguration":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"VpcId",
|
||||
"SubnetIds",
|
||||
"SecurityGroupIds"
|
||||
],
|
||||
"members":{
|
||||
"VpcId":{
|
||||
"shape":"VpcId",
|
||||
"documentation":"<p>The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.</p>"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"shape":"SubnetIds",
|
||||
"documentation":"<p>The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.</p>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIds",
|
||||
"documentation":"<p>The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.</p>"
|
||||
},
|
||||
"TlsCertificate":{
|
||||
"shape":"TlsCertificate",
|
||||
"documentation":"<p>The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The VPC configuration provisioned for the host.</p>"
|
||||
},
|
||||
"VpcId":{
|
||||
"type":"string",
|
||||
"pattern":"vpc-\\w{8}(\\w{9})?"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the Connections API to work with connections and installations.</p> <p> <i>Connections</i> are configurations that you use to connect AWS resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.</p> <p>When you create a connection, the console initiates a third-party connection handshake. <i>Installations</i> are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket Cloud app. When you create a connection, you can choose an existing installation or create one.</p> <p>You can work with connections by calling:</p> <ul> <li> <p> <a>CreateConnection</a>, which creates a uniquely named connection that can be referenced by services such as CodePipeline.</p> </li> <li> <p> <a>DeleteConnection</a>, which deletes the specified connection.</p> </li> <li> <p> <a>GetConnection</a>, which returns information about the connection, including the connection status.</p> </li> <li> <p> <a>ListConnections</a>, which lists the connections associated with your account.</p> </li> </ul> <p>For information about how to use AWS CodeStar Connections, see the <a href=\"https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html\">AWS CodePipeline User Guide</a>.</p>"
|
||||
"documentation":"<fullname>AWS CodeStar Connections</fullname> <important> <p>The CodeStar Connections feature is in preview release and is subject to change.</p> </important> <p>This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the connections API to work with connections and installations.</p> <p> <i>Connections</i> are configurations that you use to connect AWS resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.</p> <p>When you create a connection, the console initiates a third-party connection handshake. <i>Installations</i> are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket Cloud app. When you create a connection, you can choose an existing installation or create one.</p> <p>When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a <i>host</i> for your connections.</p> <p>You can work with connections by calling:</p> <ul> <li> <p> <a>CreateConnection</a>, which creates a uniquely named connection that can be referenced by services such as CodePipeline.</p> </li> <li> <p> <a>DeleteConnection</a>, which deletes the specified connection.</p> </li> <li> <p> <a>GetConnection</a>, which returns information about the connection, including the connection status.</p> </li> <li> <p> <a>ListConnections</a>, which lists the connections associated with your account.</p> </li> </ul> <p>You can work with hosts by calling:</p> <ul> <li> <p> <a>CreateHost</a>, which creates a host that represents the infrastructure where your provider is installed.</p> </li> <li> <p> <a>DeleteHost</a>, which deletes the specified host.</p> </li> <li> <p> <a>GetHost</a>, which returns information about the host, including the setup status.</p> </li> <li> <p> <a>ListHosts</a>, which lists the hosts associated with your account.</p> </li> </ul> <p>You can work with tags in AWS CodeStar Connections by calling the following:</p> <ul> <li> <p> <a>ListTagsForResource</a>, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeStar Connections.</p> </li> <li> <p> <a>TagResource</a>, which adds or updates tags for a resource in AWS CodeStar Connections.</p> </li> <li> <p> <a>UntagResource</a>, which removes tags for a resource in AWS CodeStar Connections.</p> </li> </ul> <p>For information about how to use AWS CodeStar Connections, see the <a href=\"https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html\">Developer Tools User Guide</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1327,7 +1327,8 @@
|
|||
{"shape":"InvalidSmsRoleAccessPolicyException"},
|
||||
{"shape":"InvalidSmsRoleTrustRelationshipException"}
|
||||
],
|
||||
"documentation":"<p>Initiates the authentication flow.</p>"
|
||||
"documentation":"<p>Initiates the authentication flow.</p>",
|
||||
"authtype":"none"
|
||||
},
|
||||
"ListDevices":{
|
||||
"name":"ListDevices",
|
||||
|
|
@ -1559,7 +1560,8 @@
|
|||
{"shape":"InternalErrorException"},
|
||||
{"shape":"SoftwareTokenMFANotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Responds to the authentication challenge.</p>"
|
||||
"documentation":"<p>Responds to the authentication challenge.</p>",
|
||||
"authtype":"none"
|
||||
},
|
||||
"SetRiskConfiguration":{
|
||||
"name":"SetRiskConfiguration",
|
||||
|
|
|
|||
|
|
@ -131,7 +131,7 @@
|
|||
{"shape":"KmsKeyValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see <a>how-document-classification</a>.</p>"
|
||||
"documentation":"<p>Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see <a>how-document-classification</a>.</p>"
|
||||
},
|
||||
"CreateEndpoint":{
|
||||
"name":"CreateEndpoint",
|
||||
|
|
@ -395,6 +395,7 @@
|
|||
"output":{"shape":"DetectEntitiesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceUnavailableException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"UnsupportedLanguageException"},
|
||||
{"shape":"InternalServerException"}
|
||||
|
|
@ -874,7 +875,7 @@
|
|||
"required":["TextList"],
|
||||
"members":{
|
||||
"TextList":{
|
||||
"shape":"StringList",
|
||||
"shape":"CustomerInputStringList",
|
||||
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -894,7 +895,8 @@
|
|||
"shape":"BatchItemErrorList",
|
||||
"documentation":"<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"BatchDetectEntitiesItemResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -918,7 +920,7 @@
|
|||
],
|
||||
"members":{
|
||||
"TextList":{
|
||||
"shape":"StringList",
|
||||
"shape":"CustomerInputStringList",
|
||||
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
|
|
@ -942,7 +944,8 @@
|
|||
"shape":"BatchItemErrorList",
|
||||
"documentation":"<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"BatchDetectKeyPhrasesItemResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -966,7 +969,7 @@
|
|||
],
|
||||
"members":{
|
||||
"TextList":{
|
||||
"shape":"StringList",
|
||||
"shape":"CustomerInputStringList",
|
||||
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
|
|
@ -990,7 +993,8 @@
|
|||
"shape":"BatchItemErrorList",
|
||||
"documentation":"<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"BatchDetectSentimentItemResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1018,7 +1022,7 @@
|
|||
],
|
||||
"members":{
|
||||
"TextList":{
|
||||
"shape":"StringList",
|
||||
"shape":"CustomerInputStringList",
|
||||
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
|
|
@ -1042,7 +1046,8 @@
|
|||
"shape":"BatchItemErrorList",
|
||||
"documentation":"<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"BatchDetectSyntaxItemResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1066,7 +1071,7 @@
|
|||
],
|
||||
"members":{
|
||||
"TextList":{
|
||||
"shape":"StringList",
|
||||
"shape":"CustomerInputStringList",
|
||||
"documentation":"<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
|
|
@ -1090,7 +1095,8 @@
|
|||
"shape":"BatchItemErrorList",
|
||||
"documentation":"<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"BatchItemError":{
|
||||
"type":"structure",
|
||||
|
|
@ -1173,14 +1179,15 @@
|
|||
},
|
||||
"NumberOfTestDocuments":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents.</p>"
|
||||
"documentation":"<p>The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.</p>"
|
||||
},
|
||||
"EvaluationMetrics":{
|
||||
"shape":"ClassifierEvaluationMetrics",
|
||||
"documentation":"<p> Describes the result metrics for the test data associated with an documentation classifier.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information about a document classifier.</p>"
|
||||
"documentation":"<p>Provides information about a document classifier.</p>",
|
||||
"sensitive":true
|
||||
},
|
||||
"ClassifyDocumentRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1190,7 +1197,7 @@
|
|||
],
|
||||
"members":{
|
||||
"Text":{
|
||||
"shape":"String",
|
||||
"shape":"CustomerInputString",
|
||||
"documentation":"<p>The document text to be analyzed.</p>"
|
||||
},
|
||||
"EndpointArn":{
|
||||
|
|
@ -1210,7 +1217,8 @@
|
|||
"shape":"ListOfLabels",
|
||||
"documentation":"<p>The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not multually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"ClientRequestTokenString":{
|
||||
"type":"string",
|
||||
|
|
@ -1231,7 +1239,7 @@
|
|||
"ComprehendEndpointArn":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
"pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier-endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
},
|
||||
"ComprehendEndpointName":{
|
||||
"type":"string",
|
||||
|
|
@ -1241,7 +1249,7 @@
|
|||
"ComprehendModelArn":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
"pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1405,6 +1413,16 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"CustomerInputString":{
|
||||
"type":"string",
|
||||
"min":1,
|
||||
"sensitive":true
|
||||
},
|
||||
"CustomerInputStringList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CustomerInputString"},
|
||||
"sensitive":true
|
||||
},
|
||||
"DeleteDocumentClassifierRequest":{
|
||||
"type":"structure",
|
||||
"required":["DocumentClassifierArn"],
|
||||
|
|
@ -1626,7 +1644,7 @@
|
|||
"required":["Text"],
|
||||
"members":{
|
||||
"Text":{
|
||||
"shape":"String",
|
||||
"shape":"CustomerInputString",
|
||||
"documentation":"<p>A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
}
|
||||
}
|
||||
|
|
@ -1638,22 +1656,24 @@
|
|||
"shape":"ListOfDominantLanguages",
|
||||
"documentation":"<p>The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"DetectEntitiesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Text",
|
||||
"LanguageCode"
|
||||
],
|
||||
"required":["Text"],
|
||||
"members":{
|
||||
"Text":{
|
||||
"shape":"String",
|
||||
"shape":"CustomerInputString",
|
||||
"documentation":"<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
"shape":"LanguageCode",
|
||||
"documentation":"<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p>"
|
||||
"documentation":"<p>The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.</p> <p>If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.</p>"
|
||||
},
|
||||
"EndpointArn":{
|
||||
"shape":"EntityRecognizerEndpointArn",
|
||||
"documentation":"<p>The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.</p> <p>If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1662,9 +1682,10 @@
|
|||
"members":{
|
||||
"Entities":{
|
||||
"shape":"ListOfEntities",
|
||||
"documentation":"<p>A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see <a>how-entities</a>. </p>"
|
||||
"documentation":"<p>A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. </p> <p>If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see <a>how-entities</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"DetectKeyPhrasesRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1674,7 +1695,7 @@
|
|||
],
|
||||
"members":{
|
||||
"Text":{
|
||||
"shape":"String",
|
||||
"shape":"CustomerInputString",
|
||||
"documentation":"<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
|
|
@ -1690,7 +1711,8 @@
|
|||
"shape":"ListOfKeyPhrases",
|
||||
"documentation":"<p>A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"DetectSentimentRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1700,7 +1722,7 @@
|
|||
],
|
||||
"members":{
|
||||
"Text":{
|
||||
"shape":"String",
|
||||
"shape":"CustomerInputString",
|
||||
"documentation":"<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
|
|
@ -1720,7 +1742,8 @@
|
|||
"shape":"SentimentScore",
|
||||
"documentation":"<p>An object that lists the sentiments, and their corresponding confidence levels.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"DetectSyntaxRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1730,7 +1753,7 @@
|
|||
],
|
||||
"members":{
|
||||
"Text":{
|
||||
"shape":"String",
|
||||
"shape":"CustomerInputString",
|
||||
"documentation":"<p>A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.</p>"
|
||||
},
|
||||
"LanguageCode":{
|
||||
|
|
@ -1746,7 +1769,8 @@
|
|||
"shape":"ListOfSyntaxTokens",
|
||||
"documentation":"<p>A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see <a>how-syntax</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sensitive":true
|
||||
},
|
||||
"DocumentClass":{
|
||||
"type":"structure",
|
||||
|
|
@ -1775,11 +1799,11 @@
|
|||
},
|
||||
"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 after the specified time. Jobs are returned in ascending order, oldest to newest.</p>"
|
||||
"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 before the specified time. Jobs are returned in descending order, newest to oldest.</p>"
|
||||
"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 document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.</p>"
|
||||
|
|
@ -2292,6 +2316,11 @@
|
|||
},
|
||||
"documentation":"<p>Describes the training documents submitted with an entity recognizer.</p>"
|
||||
},
|
||||
"EntityRecognizerEndpointArn":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*"
|
||||
},
|
||||
"EntityRecognizerEntityList":{
|
||||
"type":"structure",
|
||||
"required":["S3Uri"],
|
||||
|
|
@ -2385,7 +2414,8 @@
|
|||
"documentation":"<p>Entity types from the metadata of an entity recognizer.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Detailed information about an entity recognizer.</p>"
|
||||
"documentation":"<p>Detailed information about an entity recognizer.</p>",
|
||||
"sensitive":true
|
||||
},
|
||||
"EntityRecognizerMetadataEntityTypesList":{
|
||||
"type":"list",
|
||||
|
|
@ -3166,7 +3196,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>The specified name is already in use. Use a different name and try your request again.</p>",
|
||||
"documentation":"<p>The specified resource name is already in use. Use a different name and try your request again.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ResourceLimitExceededException":{
|
||||
|
|
@ -3174,7 +3204,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup, and then try your request again.</p>",
|
||||
"documentation":"<p>The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
|
|
@ -3190,7 +3220,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"documentation":"<p>The specified resource is not available. Check to see if the resource is in the <code>TRAINED</code> state and try your request again.</p>",
|
||||
"documentation":"<p>The specified resource is not available. Check the resource and try your request again.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"S3Uri":{
|
||||
|
|
@ -3787,10 +3817,6 @@
|
|||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"StringList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SubnetId":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
|
|
|
|||
|
|
@ -1259,7 +1259,8 @@
|
|||
"ACUITY",
|
||||
"TEST_VALUE",
|
||||
"TEST_UNITS",
|
||||
"DIRECTION"
|
||||
"DIRECTION",
|
||||
"SYSTEM_ORGAN_SITE"
|
||||
]
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Creates a user account for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Creates a user account for the specified Amazon Connect instance.</p> <p>For information about how to create user accounts using the Amazon Connect console, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html\">Add Users</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"DeleteUser":{
|
||||
"name":"DeleteUser",
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a user account from the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Deletes a user account from the specified Amazon Connect instance.</p> <p>For information about what happens to a user's data when their account is deleted, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html\">Delete Users from Your Amazon Connect Instance</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"DescribeUser":{
|
||||
"name":"DescribeUser",
|
||||
|
|
@ -129,7 +129,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Gets the real-time metric data from the specified Amazon Connect instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-reports.html\">Real-time Metrics Reports</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
"documentation":"<p>Gets the real-time metric data from the specified Amazon Connect instance.</p> <p>For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"GetFederationToken":{
|
||||
"name":"GetFederationToken",
|
||||
|
|
@ -164,7 +164,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Gets historical metric data from the specified Amazon Connect instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics.html\">Historical Metrics Reports</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
"documentation":"<p>Gets historical metric data from the specified Amazon Connect instance.</p> <p>For a description of each historical metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListContactFlows":{
|
||||
"name":"ListContactFlows",
|
||||
|
|
@ -181,7 +181,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides information about the contact flows for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Provides information about the contact flows for the specified Amazon Connect instance.</p> <p>For more information about contact flows, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html\">Contact Flows</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListHoursOfOperations":{
|
||||
"name":"ListHoursOfOperations",
|
||||
|
|
@ -198,7 +198,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides information about the hours of operation for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Provides information about the hours of operation for the specified Amazon Connect instance.</p> <p>For more information about hours of operation, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html\">Set the Hours of Operation for a Queue</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListPhoneNumbers":{
|
||||
"name":"ListPhoneNumbers",
|
||||
|
|
@ -215,7 +215,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides information about the phone numbers for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Provides information about the phone numbers for the specified Amazon Connect instance. </p> <p>For more information about phone numbers, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html\">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListQueues":{
|
||||
"name":"ListQueues",
|
||||
|
|
@ -232,7 +232,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides information about the queues for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Provides information about the queues for the specified Amazon Connect instance.</p> <p>For more information about queues, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html\">Queues: Standard and Agent</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListRoutingProfiles":{
|
||||
"name":"ListRoutingProfiles",
|
||||
|
|
@ -249,7 +249,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides summary information about the routing profiles for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Provides summary information about the routing profiles for the specified Amazon Connect instance.</p> <p>For more information about routing profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html\">Routing Profiles</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html\">Create a Routing Profile</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListSecurityProfiles":{
|
||||
"name":"ListSecurityProfiles",
|
||||
|
|
@ -266,7 +266,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides summary information about the security profiles for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Provides summary information about the security profiles for the specified Amazon Connect instance.</p> <p>For more information about security profiles, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html\">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
|
|
@ -283,7 +283,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Lists the tags for the specified resource.</p>"
|
||||
"documentation":"<p>Lists the tags for the specified resource.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListUserHierarchyGroups":{
|
||||
"name":"ListUserHierarchyGroups",
|
||||
|
|
@ -300,7 +300,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Provides summary information about the hierarchy groups for the specified Amazon Connect instance.</p>"
|
||||
"documentation":"<p>Provides summary information about the hierarchy groups for the specified Amazon Connect instance.</p> <p>For more information about agent hierarchies, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html\">Set Up Agent Hierarchies</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"ListUsers":{
|
||||
"name":"ListUsers",
|
||||
|
|
@ -334,7 +334,7 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p>"
|
||||
"documentation":"<p>Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> API in the Amazon Connect Participant Service.</p> <p>When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking <a href=\"https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html\">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </p> <p>A 429 error occurs in two situations:</p> <ul> <li> <p>API rate limit is exceeded. API TPS throttling returns a <code>TooManyRequests</code> exception from the API Gateway.</p> </li> <li> <p>The <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <code>LimitExceededException</code>.</p> </li> </ul> <p>For more information about how chat works, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/chat.html\">Chat</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"StartOutboundVoiceContact":{
|
||||
"name":"StartOutboundVoiceContact",
|
||||
|
|
@ -353,7 +353,7 @@
|
|||
{"shape":"DestinationNotAllowedException"},
|
||||
{"shape":"OutboundContactNotPermittedException"}
|
||||
],
|
||||
"documentation":"<p>Initiates a contact flow to place an outbound call to a customer.</p> <p>There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.</p>"
|
||||
"documentation":"<p>This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in <code>ContactFlowId</code>).</p> <p>Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.</p> <p>There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.</p> <note> <p>UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </p> </note>"
|
||||
},
|
||||
"StopContact":{
|
||||
"name":"StopContact",
|
||||
|
|
@ -386,7 +386,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"}
|
||||
],
|
||||
"documentation":"<p>Adds the specified tags to the specified resource.</p> <p>The supported resource type is users.</p>"
|
||||
"documentation":"<p>Adds the specified tags to the specified resource.</p> <p>The supported resource type is users.</p> <p>For sample policies that use tags, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html\">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
|
|
@ -450,7 +450,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Updates the identity information for the specified user.</p>"
|
||||
"documentation":"<p>Updates the identity information for the specified user.</p> <important> <p>Someone with the ability to invoke <code>UpdateUserIndentityInfo</code> can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke <code>UpdateUserIndentityInfo</code>. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html\">Best Practices for Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>.</p> </important>"
|
||||
},
|
||||
"UpdateUserPhoneConfig":{
|
||||
"name":"UpdateUserPhoneConfig",
|
||||
|
|
@ -754,7 +754,7 @@
|
|||
"documentation":"<p>The unit for the metric.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about a real-time metric.</p>"
|
||||
"documentation":"<p>Contains information about a real-time metric. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"CurrentMetricData":{
|
||||
"type":"structure",
|
||||
|
|
@ -1028,7 +1028,7 @@
|
|||
},
|
||||
"CurrentMetrics":{
|
||||
"shape":"CurrentMetrics",
|
||||
"documentation":"<p>The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:</p> <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd> <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> </dl>"
|
||||
"documentation":"<p>The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html\">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time\">ACW</a> </p> </dd> <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time\">Available</a> </p> </dd> <dt>AGENTS_ERROR</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time\">Error</a> </p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time\">NPT (Non-Productive Time)</a> </p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ONLINE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time\">Online</a> </p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time\">Staffed</a> </p> </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time\">In queue</a> </p> </dd> <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time\">Scheduled</a> </p> </dd> <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> <p>When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:</p> <p> <code>{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 </code>}</p> <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time\">Oldest</a> </p> </dd> <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time\">Active</a> </p> </dd> <dt>SLOTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time\">Availability</a> </p> </dd> </dl>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -1113,7 +1113,7 @@
|
|||
},
|
||||
"HistoricalMetrics":{
|
||||
"shape":"HistoricalMetrics",
|
||||
"documentation":"<p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:</p> <dl> <dt>ABANDON_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>API_CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CALLBACK_CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_ABANDONED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_CONSULTED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED_INCOMING</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED_OUTBOUND</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HOLD_ABANDONS</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_MISSED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_QUEUED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_IN</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_OUT</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>HANDLE_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>HOLD_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>INTERACTION_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>OCCUPANCY</dt> <dd> <p>Unit: PERCENT</p> <p>Statistic: AVG</p> </dd> <dt>QUEUE_ANSWER_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>QUEUED_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: MAX</p> </dd> <dt>SERVICE_LEVEL</dt> <dd> <p>Unit: PERCENT</p> <p>Statistic: AVG</p> <p>Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600</p> </dd> </dl>"
|
||||
"documentation":"<p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <dl> <dt>ABANDON_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>AFTER_CONTACT_WORK_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>API_CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CALLBACK_CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_ABANDONED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_CONSULTED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED_INCOMING</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HANDLED_OUTBOUND</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_HOLD_ABANDONS</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_MISSED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_QUEUED</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_IN</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_OUT</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Statistic: SUM</p> </dd> <dt>HANDLE_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>HOLD_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>INTERACTION_AND_HOLD_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>INTERACTION_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>OCCUPANCY</dt> <dd> <p>Unit: PERCENT</p> <p>Statistic: AVG</p> </dd> <dt>QUEUE_ANSWER_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: AVG</p> </dd> <dt>QUEUED_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>Statistic: MAX</p> </dd> <dt>SERVICE_LEVEL</dt> <dd> <p>Unit: PERCENT</p> <p>Statistic: AVG</p> <p>Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600</p> </dd> </dl>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -1294,7 +1294,7 @@
|
|||
"documentation":"<p>The unit for the metric.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains information about a historical metric.</p>"
|
||||
"documentation":"<p>Contains information about a historical metric. For a description of each metric, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html\">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
},
|
||||
"HistoricalMetricData":{
|
||||
"type":"structure",
|
||||
|
|
@ -2289,7 +2289,7 @@
|
|||
},
|
||||
"ContactFlowId":{
|
||||
"shape":"ContactFlowId",
|
||||
"documentation":"<p>The identifier of the contact flow for the chat.</p>"
|
||||
"documentation":"<p>The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>"
|
||||
},
|
||||
"Attributes":{
|
||||
"shape":"Attributes",
|
||||
|
|
@ -2341,7 +2341,7 @@
|
|||
},
|
||||
"ContactFlowId":{
|
||||
"shape":"ContactFlowId",
|
||||
"documentation":"<p>The identifier of the contact flow for the outbound call.</p>"
|
||||
"documentation":"<p>The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p> <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b> </p>"
|
||||
},
|
||||
"InstanceId":{
|
||||
"shape":"InstanceId",
|
||||
|
|
@ -2779,5 +2779,5 @@
|
|||
"Value":{"type":"double"},
|
||||
"timestamp":{"type":"timestamp"}
|
||||
},
|
||||
"documentation":"<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p> <p>Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.</p> <p>There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Limits</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
|
||||
"documentation":"<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p> <p>Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.</p> <p>There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html\">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <p>To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect Endpoints</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -808,7 +808,7 @@
|
|||
"documentation":"<p>The name of the Availability Zone.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The name of the Availability Zone for use during database migration.</p>"
|
||||
"documentation":"<p>The name of an Availability Zone for use during database migration.</p>"
|
||||
},
|
||||
"AvailabilityZonesList":{
|
||||
"type":"list",
|
||||
|
|
@ -887,7 +887,7 @@
|
|||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The connection status.</p>"
|
||||
"documentation":"<p>The connection status. This parameter can return one of the following values:</p> <ul> <li> <p> <code>\"successful\"</code> </p> </li> <li> <p> <code>\"testing\"</code> </p> </li> <li> <p> <code>\"failed\"</code> </p> </li> <li> <p> <code>\"deleting\"</code> </p> </li> </ul>"
|
||||
},
|
||||
"LastFailureMessage":{
|
||||
"shape":"String",
|
||||
|
|
@ -926,7 +926,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the <code>EndpointType</code> value, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the <code>EndpointType</code> value, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, <code>\"sqlserver\"</code>, and <code>\"neptune\"</code>.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
|
|
@ -994,19 +994,19 @@
|
|||
},
|
||||
"KinesisSettings":{
|
||||
"shape":"KinesisSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html\">Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html\">Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"KafkaSettings":{
|
||||
"shape":"KafkaSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html\">Using Apache Kafka as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html\">Using Apache Kafka as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"ElasticsearchSettings":{
|
||||
"shape":"ElasticsearchSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration\">Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration\">Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS</a> in the <i>AWS Database Migration Service User Guide</i>.</p>"
|
||||
},
|
||||
"NeptuneSettings":{
|
||||
"shape":"NeptuneSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings\">https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings\">Specifying Endpoint Settings for Amazon Neptune as a Target</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"RedshiftSettings":{"shape":"RedshiftSettings"}
|
||||
},
|
||||
|
|
@ -1079,7 +1079,7 @@
|
|||
"members":{
|
||||
"ReplicationInstanceIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters 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> <p>Example: <code>myrepinstance</code> </p>"
|
||||
"documentation":"<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-63 alphanumeric characters 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> <p>Example: <code>myrepinstance</code> </p>"
|
||||
},
|
||||
"AllocatedStorage":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -1087,7 +1087,7 @@
|
|||
},
|
||||
"ReplicationInstanceClass":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance as specified by the replication instance class.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>"
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to <code>\"dms.c4.large\"</code>.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth\"> Selecting the right AWS DMS replication instance for your migration</a>. </p>"
|
||||
},
|
||||
"VpcSecurityGroupIds":{
|
||||
"shape":"VpcSecurityGroupIdList",
|
||||
|
|
@ -1131,7 +1131,7 @@
|
|||
},
|
||||
"DnsNameServers":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A list of DNS name servers supported for the replication instance.</p>"
|
||||
"documentation":"<p>A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: <code>\"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -1196,7 +1196,7 @@
|
|||
"members":{
|
||||
"ReplicationTaskIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An identifier for the replication task.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
"documentation":"<p>An identifier for the replication task.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"SourceEndpointArn":{
|
||||
"shape":"String",
|
||||
|
|
@ -1216,7 +1216,7 @@
|
|||
},
|
||||
"TableMappings":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The table mappings for the task, in JSON format. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html\">Using Table Mapping to Specify Task Settings</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>The table mappings for the task, in JSON format. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html\">Using Table Mapping to Specify Task Settings</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"ReplicationTaskSettings":{
|
||||
"shape":"String",
|
||||
|
|
@ -1240,7 +1240,7 @@
|
|||
},
|
||||
"TaskData":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html\">Specifying Supplemental Data for Task Settings</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html\">Specifying Supplemental Data for Task Settings</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -2090,7 +2090,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, <code>\"sqlserver\"</code>, and <code>\"neptune\"</code>.</p>"
|
||||
},
|
||||
"EngineDisplayName":{
|
||||
"shape":"String",
|
||||
|
|
@ -2178,7 +2178,7 @@
|
|||
},
|
||||
"NeptuneSettings":{
|
||||
"shape":"NeptuneSettings",
|
||||
"documentation":"<p>The settings for the MongoDB source endpoint. For more information, see the <code>NeptuneSettings</code> structure.</p>"
|
||||
"documentation":"<p>The settings for the Amazon Neptune target endpoint. For more information, see the <code>NeptuneSettings</code> structure.</p>"
|
||||
},
|
||||
"RedshiftSettings":{
|
||||
"shape":"RedshiftSettings",
|
||||
|
|
@ -2264,7 +2264,7 @@
|
|||
},
|
||||
"SubscriptionCreationTime":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The time the RDS event notification subscription was created.</p>"
|
||||
"documentation":"<p>The time the AWS DMS event notification subscription was created.</p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"String",
|
||||
|
|
@ -2552,7 +2552,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, <code>\"sqlserver\"</code>, and <code>\"neptune\"</code>.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
|
|
@ -2612,19 +2612,19 @@
|
|||
},
|
||||
"KinesisSettings":{
|
||||
"shape":"KinesisSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html\">Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html\">Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"KafkaSettings":{
|
||||
"shape":"KafkaSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html\">Using Apache Kafka as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html\">Using Apache Kafka as a Target for AWS Database Migration Service</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"ElasticsearchSettings":{
|
||||
"shape":"ElasticsearchSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration\">Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration\">Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"NeptuneSettings":{
|
||||
"shape":"NeptuneSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings\">https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings\">Specifying Endpoint Settings for Amazon Neptune as a Target</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
},
|
||||
"RedshiftSettings":{"shape":"RedshiftSettings"}
|
||||
},
|
||||
|
|
@ -2695,7 +2695,7 @@
|
|||
},
|
||||
"ReplicationInstanceClass":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>"
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to <code>\"dms.c4.large\"</code>.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth\"> Selecting the right AWS DMS replication instance for your migration</a>. </p>"
|
||||
},
|
||||
"VpcSecurityGroupIds":{
|
||||
"shape":"VpcSecurityGroupIdList",
|
||||
|
|
@ -2780,7 +2780,7 @@
|
|||
},
|
||||
"ReplicationTaskIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"MigrationType":{
|
||||
"shape":"MigrationTypeValue",
|
||||
|
|
@ -2808,7 +2808,7 @@
|
|||
},
|
||||
"TaskData":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html\">Specifying Supplemental Data for Task Settings</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html\">Specifying Supplemental Data for Task Settings</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -2848,27 +2848,27 @@
|
|||
},
|
||||
"AuthType":{
|
||||
"shape":"AuthTypeValue",
|
||||
"documentation":"<p> The authentication type you use to access the MongoDB source endpoint.</p> <p>Valid values: NO, PASSWORD </p> <p>When NO is selected, user name and password parameters are not used and can be empty. </p>"
|
||||
"documentation":"<p> The authentication type you use to access the MongoDB source endpoint.</p> <p>When when set to <code>\"no\"</code>, user name and password parameters are not used and can be empty. </p>"
|
||||
},
|
||||
"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 setting isn't used when authType=No.</p>"
|
||||
"documentation":"<p> The authentication mechanism you use to access the MongoDB source endpoint.</p> <p>For the default value, in MongoDB version 2.x, <code>\"default\"</code> is <code>\"mongodb_cr\"</code>. For MongoDB version 3.x or later, <code>\"default\"</code> is <code>\"scram_sha_1\"</code>. This setting isn't used when <code>AuthType</code> is set to <code>\"no\"</code>.</p>"
|
||||
},
|
||||
"NestingLevel":{
|
||||
"shape":"NestingLevelValue",
|
||||
"documentation":"<p> Specifies either document or table mode. </p> <p>Valid values: NONE, ONE</p> <p>Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.</p>"
|
||||
"documentation":"<p> Specifies either document or table mode. </p> <p>Default value is <code>\"none\"</code>. Specify <code>\"none\"</code> to use document mode. Specify <code>\"one\"</code> to use table mode.</p>"
|
||||
},
|
||||
"ExtractDocId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> Specifies the document ID. Use this setting 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 <code>\"none\"</code>. </p> <p>Default value is <code>\"false\"</code>. </p>"
|
||||
},
|
||||
"DocsToInvestigate":{
|
||||
"shape":"String",
|
||||
"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>"
|
||||
"documentation":"<p> Indicates the number of documents to preview to determine the document organization. Use this setting when <code>NestingLevel</code> is set to <code>\"one\"</code>. </p> <p>Must be a positive value greater than <code>0</code>. Default value is <code>1000</code>.</p>"
|
||||
},
|
||||
"AuthSource":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The MongoDB database name. This setting isn't used when <code>authType=NO</code>. </p> <p>The default is admin.</p>"
|
||||
"documentation":"<p> The MongoDB database name. This setting isn't used when <code>AuthType</code> is set to <code>\"no\"</code>. </p> <p>The default is <code>\"admin\"</code>.</p>"
|
||||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"String",
|
||||
|
|
@ -2886,15 +2886,15 @@
|
|||
"members":{
|
||||
"ServiceAccessRoleArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The ARN of the service role you have created for the Neptune target endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole\">https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole\">Creating an IAM Service Role for Accessing Amazon Neptune as a Target</a> in the <i>AWS Database Migration Service User Guide. </i> </p>"
|
||||
},
|
||||
"S3BucketName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the S3 bucket for AWS DMS to temporarily store migrated graph data in CSV files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these CSV files.</p>"
|
||||
"documentation":"<p>The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.</p>"
|
||||
},
|
||||
"S3BucketFolder":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A folder path where you where you want AWS DMS to store migrated graph data in the S3 bucket specified by <code>S3BucketName</code> </p>"
|
||||
"documentation":"<p>A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by <code>S3BucketName</code> </p>"
|
||||
},
|
||||
"ErrorRetryDuration":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -2902,15 +2902,15 @@
|
|||
},
|
||||
"MaxFileSize":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum size in KB of migrated graph data stored in a CSV file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1048576 KB. If successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.</p>"
|
||||
"documentation":"<p>The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.</p>"
|
||||
},
|
||||
"MaxRetryCount":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of times for AWS DMS to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 5.</p>"
|
||||
"documentation":"<p>The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.</p>"
|
||||
},
|
||||
"IamAuthEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>If you want IAM authorization enabled for this endpoint, set this parameter to <code>true</code> and attach the appropriate role policy document to your service role specified by <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</p>"
|
||||
"documentation":"<p>If you want AWS Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to <code>true</code>. Then attach the appropriate IAM policy document to your service role specified by <code>ServiceAccessRoleArn</code>. The default is <code>false</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information that defines an Amazon Neptune endpoint.</p>"
|
||||
|
|
@ -2931,7 +2931,7 @@
|
|||
},
|
||||
"ReplicationInstanceClass":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>"
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to <code>\"dms.c4.large\"</code>.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth\"> Selecting the right AWS DMS replication instance for your migration</a>. </p>"
|
||||
},
|
||||
"StorageType":{
|
||||
"shape":"String",
|
||||
|
|
@ -3281,15 +3281,15 @@
|
|||
"members":{
|
||||
"ReplicationInstanceIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>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>myrepinstance</code> </p>"
|
||||
"documentation":"<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-63 alphanumeric characters or hyphens.</p> </li> <li> <p>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>myrepinstance</code> </p>"
|
||||
},
|
||||
"ReplicationInstanceClass":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>"
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth\"> Selecting the right AWS DMS replication instance for your migration</a>. </p>"
|
||||
},
|
||||
"ReplicationInstanceStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the replication instance.</p>"
|
||||
"documentation":"<p>The status of the replication instance. The possible return values include:</p> <ul> <li> <p> <code>\"available\"</code> </p> </li> <li> <p> <code>\"creating\"</code> </p> </li> <li> <p> <code>\"deleted\"</code> </p> </li> <li> <p> <code>\"deleting\"</code> </p> </li> <li> <p> <code>\"failed\"</code> </p> </li> <li> <p> <code>\"modifying\"</code> </p> </li> <li> <p> <code>\"upgrading\"</code> </p> </li> <li> <p> <code>\"rebooting\"</code> </p> </li> <li> <p> <code>\"resetting-master-credentials\"</code> </p> </li> <li> <p> <code>\"storage-full\"</code> </p> </li> <li> <p> <code>\"incompatible-credentials\"</code> </p> </li> <li> <p> <code>\"incompatible-network\"</code> </p> </li> <li> <p> <code>\"maintenance\"</code> </p> </li> </ul>"
|
||||
},
|
||||
"AllocatedStorage":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -3371,7 +3371,7 @@
|
|||
},
|
||||
"DnsNameServers":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The DNS name servers for the replication instance.</p>"
|
||||
"documentation":"<p>The DNS name servers supported for the replication instance to access your on-premise source or target database.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information that defines a replication instance.</p>"
|
||||
|
|
@ -3415,7 +3415,7 @@
|
|||
"members":{
|
||||
"ReplicationInstanceClass":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>"
|
||||
"documentation":"<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth\"> Selecting the right AWS DMS replication instance for your migration</a>. </p>"
|
||||
},
|
||||
"AllocatedStorage":{
|
||||
"shape":"IntegerOptional",
|
||||
|
|
@ -3478,7 +3478,7 @@
|
|||
"members":{
|
||||
"ReplicationTaskIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The user-assigned replication task identifier or name.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
"documentation":"<p>The user-assigned replication task identifier or name.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"SourceEndpointArn":{
|
||||
"shape":"String",
|
||||
|
|
@ -3514,7 +3514,7 @@
|
|||
},
|
||||
"StopReason":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The reason the replication task was stopped.</p>"
|
||||
"documentation":"<p>The reason the replication task was stopped. This response parameter can return one of the following values:</p> <ul> <li> <p> <code>\"STOP_REASON_FULL_LOAD_COMPLETED\"</code> – Full-load migration completed.</p> </li> <li> <p> <code>\"STOP_REASON_CACHED_CHANGES_APPLIED\"</code> – Change data capture (CDC) load completed.</p> </li> <li> <p> <code>\"STOP_REASON_CACHED_CHANGES_NOT_APPLIED\"</code> – In a full-load and CDC migration, the full-load stopped as specified before starting the CDC migration.</p> </li> <li> <p> <code>\"STOP_REASON_SERVER_TIME\"</code> – The migration stopped at the specified server time.</p> </li> </ul>"
|
||||
},
|
||||
"ReplicationTaskCreationDate":{
|
||||
"shape":"TStamp",
|
||||
|
|
@ -3546,7 +3546,7 @@
|
|||
},
|
||||
"TaskData":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html\">Specifying Supplemental Data for Task Settings</a> in the <i>AWS Database Migration User Guide.</i> </p>"
|
||||
"documentation":"<p>Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see <a href=\"https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html\">Specifying Supplemental Data for Task Settings</a> in the <i>AWS Database Migration Service User Guide.</i> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information that describes a replication task created by the <code>CreateReplicationTask</code> operation.</p>"
|
||||
|
|
@ -3964,7 +3964,7 @@
|
|||
"members":{
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, and <code>\"sqlserver\"</code>.</p>"
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndpointType, include <code>\"mysql\"</code>, <code>\"oracle\"</code>, <code>\"postgres\"</code>, <code>\"mariadb\"</code>, <code>\"aurora\"</code>, <code>\"aurora-postgresql\"</code>, <code>\"redshift\"</code>, <code>\"s3\"</code>, <code>\"db2\"</code>, <code>\"azuredb\"</code>, <code>\"sybase\"</code>, <code>\"dynamodb\"</code>, <code>\"mongodb\"</code>, <code>\"kinesis\"</code>, <code>\"kafka\"</code>, <code>\"elasticsearch\"</code>, <code>\"documentdb\"</code>, <code>\"sqlserver\"</code>, and <code>\"neptune\"</code>.</p>"
|
||||
},
|
||||
"SupportsCDC":{
|
||||
"shape":"Boolean",
|
||||
|
|
@ -4099,11 +4099,11 @@
|
|||
"members":{
|
||||
"Key":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
"documentation":"<p>A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
"documentation":"<p>A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:</p> <ul> <li> <p> <code>AddTagsToResource</code> </p> </li> <li> <p> <code>ListTagsForResource</code> </p> </li> <li> <p> <code>RemoveTagsFromResource</code> </p> </li> </ul>"
|
||||
|
|
@ -4160,14 +4160,14 @@
|
|||
"members":{
|
||||
"VpcSecurityGroupId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The VPC security group Id.</p>"
|
||||
"documentation":"<p>The VPC security group ID.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the VPC security group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes status of a security group associated with the virtual private cloud hosting your replication and DB instances.</p>"
|
||||
"documentation":"<p>Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.</p>"
|
||||
},
|
||||
"VpcSecurityGroupMembershipList":{
|
||||
"type":"list",
|
||||
|
|
|
|||
|
|
@ -1,5 +1,29 @@
|
|||
{
|
||||
"pagination": {
|
||||
"DescribeCertificates": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "Certificates"
|
||||
},
|
||||
"DescribeDBClusterParameterGroups": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "DBClusterParameterGroups"
|
||||
},
|
||||
"DescribeDBClusterParameters": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "Parameters"
|
||||
},
|
||||
"DescribeDBClusterSnapshots": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "DBClusterSnapshots"
|
||||
},
|
||||
"DescribeDBClusters": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
|
|
@ -35,6 +59,12 @@
|
|||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "OrderableDBInstanceOptions"
|
||||
},
|
||||
"DescribePendingMaintenanceActions": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxRecords",
|
||||
"output_token": "Marker",
|
||||
"result_key": "PendingMaintenanceActions"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@
|
|||
{"shape":"InvalidDBClusterStateFault"},
|
||||
{"shape":"InvalidDBInstanceStateFault"}
|
||||
],
|
||||
"documentation":"<p>Applies a pending maintenance action to a resource (for example, to a DB instance).</p>"
|
||||
"documentation":"<p>Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).</p>"
|
||||
},
|
||||
"CopyDBClusterParameterGroup":{
|
||||
"name":"CopyDBClusterParameterGroup",
|
||||
|
|
@ -82,7 +82,7 @@
|
|||
{"shape":"SnapshotQuotaExceededFault"},
|
||||
{"shape":"KMSKeyNotAccessibleFault"}
|
||||
],
|
||||
"documentation":"<p>Copies a snapshot of a cluster.</p> <p>To copy a cluster snapshot from a shared manual cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared cluster snapshot.</p> <p>To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that DB cluster snapshot is in the <i>copying</i> status.</p>"
|
||||
"documentation":"<p>Copies a snapshot of a cluster.</p> <p>To copy a cluster snapshot from a shared manual cluster snapshot, <code>SourceDBClusterSnapshotIdentifier</code> must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same AWS Region.</p> <p>To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by <code>TargetDBClusterSnapshotIdentifier</code> while that cluster snapshot is in the <i>copying</i> status.</p>"
|
||||
},
|
||||
"CreateDBCluster":{
|
||||
"name":"CreateDBCluster",
|
||||
|
|
@ -129,7 +129,7 @@
|
|||
{"shape":"DBParameterGroupQuotaExceededFault"},
|
||||
{"shape":"DBParameterGroupAlreadyExistsFault"}
|
||||
],
|
||||
"documentation":"<p>Creates a new cluster parameter group.</p> <p>Parameters in a cluster parameter group apply to all of the instances in a DB cluster.</p> <p>A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover.</p> <important> <p>After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter.</p> </important>"
|
||||
"documentation":"<p>Creates a new cluster parameter group.</p> <p>Parameters in a cluster parameter group apply to all of the instances in a cluster.</p> <p>A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the <code>default.docdb3.6</code> cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html\"> create a new parameter group</a> or <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html\"> copy an existing parameter group</a>, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html\"> Modifying Amazon DocumentDB Cluster Parameter Groups</a>. </p>"
|
||||
},
|
||||
"CreateDBClusterSnapshot":{
|
||||
"name":"CreateDBClusterSnapshot",
|
||||
|
|
@ -795,14 +795,14 @@
|
|||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name (ARN).</p>"
|
||||
"documentation":"<p>The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The tags to be assigned to the Amazon DocumentDB resource. </p>"
|
||||
"documentation":"<p>The tags to be assigned to the Amazon DocumentDB resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input to <a>AddTagsToResource</a>.</p>"
|
||||
"documentation":"<p>Represents the input to <a>AddTagsToResource</a>. </p>"
|
||||
},
|
||||
"ApplyMethod":{
|
||||
"type":"string",
|
||||
|
|
@ -829,10 +829,10 @@
|
|||
},
|
||||
"OptInType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type <code>immediate</code> can't be undone.</p> <p>Valid values:</p> <ul> <li> <p> <code>immediate</code> - Apply the maintenance action immediately.</p> </li> <li> <p> <code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource.</p> </li> <li> <p> <code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests.</p> </li> </ul>"
|
||||
"documentation":"<p>A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type <code>immediate</code> can't be undone.</p> <p>Valid values:</p> <ul> <li> <p> <code>immediate</code> - Apply the maintenance action immediately.</p> </li> <li> <p> <code>next-maintenance</code> - Apply the maintenance action during the next maintenance window for the resource. </p> </li> <li> <p> <code>undo-opt-in</code> - Cancel any existing <code>next-maintenance</code> opt-in requests.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input to <a>ApplyPendingMaintenanceAction</a>.</p>"
|
||||
"documentation":"<p>Represents the input to <a>ApplyPendingMaintenanceAction</a>. </p>"
|
||||
},
|
||||
"ApplyPendingMaintenanceActionResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -973,11 +973,11 @@
|
|||
"members":{
|
||||
"SourceDBClusterParameterGroupIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid cluster parameter group.</p> </li> <li> <p>If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, <code>my-db-cluster-param-group</code>, or a valid ARN.</p> </li> <li> <p>If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, <code>arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid cluster parameter group.</p> </li> <li> <p>If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, <code>my-db-cluster-param-group</code>, or a valid ARN.</p> </li> <li> <p>If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, <code>arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group</code>.</p> </li> </ul>"
|
||||
},
|
||||
"TargetDBClusterParameterGroupIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier for the copied cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Cannot be null, empty, or blank.</p> </li> <li> <p>Must contain from 1 to 255 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>my-cluster-param-group1</code> </p>"
|
||||
"documentation":"<p>The identifier for the copied cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Cannot be null, empty, or blank.</p> </li> <li> <p>Must contain from 1 to 255 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>my-cluster-param-group1</code> </p>"
|
||||
},
|
||||
"TargetDBClusterParameterGroupDescription":{
|
||||
"shape":"String",
|
||||
|
|
@ -988,7 +988,7 @@
|
|||
"documentation":"<p>The tags that are to be assigned to the parameter group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input to <a>CopyDBClusterParameterGroup</a>.</p>"
|
||||
"documentation":"<p>Represents the input to <a>CopyDBClusterParameterGroup</a>. </p>"
|
||||
},
|
||||
"CopyDBClusterParameterGroupResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1005,19 +1005,19 @@
|
|||
"members":{
|
||||
"SourceDBClusterSnapshotIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the cluster snapshot to copy. This parameter is not case sensitive.</p> <p>You can't copy an encrypted, shared cluster snapshot from one AWS Region to another.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the \"available\" state.</p> </li> <li> <p>If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
|
||||
"documentation":"<p>The identifier of the cluster snapshot to copy. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid system snapshot in the <i>available</i> state.</p> </li> <li> <p>If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.</p> </li> <li> <p>If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.</p> </li> </ul> <p>Example: <code>my-cluster-snapshot1</code> </p>"
|
||||
},
|
||||
"TargetDBClusterSnapshotIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.</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>my-cluster-snapshot2</code> </p>"
|
||||
"documentation":"<p>The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.</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>my-cluster-snapshot2</code> </p>"
|
||||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. </p> <p>If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot. </p> <p>If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>. </p> <p>To copy an encrypted cluster snapshot to another AWS Region, set <code>KmsKeyId</code> to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.</p> <p>If you copy an unencrypted cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
|
||||
"documentation":"<p>The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key. </p> <p>If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for <code>KmsKeyId</code> to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for <code>KmsKeyId</code>, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot. </p> <p>If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for <code>KmsKeyId</code>.</p> <p>To copy an encrypted cluster snapshot to another AWS Region, set <code>KmsKeyId</code> to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.</p> <p>If you copy an unencrypted cluster snapshot and specify a value for the <code>KmsKeyId</code> parameter, an error is returned.</p>"
|
||||
},
|
||||
"PreSignedUrl":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source cluster snapshot to copy. You must use the <code>PreSignedUrl</code> parameter when copying an encrypted cluster snapshot from another AWS Region.</p> <p>The presigned URL must be a valid request for the <code>CopyDBSClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:</p> <ul> <li> <p> <code>KmsKeyId</code> - The AWS KMS key identifier for the key to use to encrypt the copy of the cluster snapshot in the destination AWS Region. This is the same identifier for both the <code>CopyDBClusterSnapshot</code> action that is called in the destination AWS Region, and the action contained in the presigned URL.</p> </li> <li> <p> <code>DestinationRegion</code> - The name of the AWS Region that the DB cluster snapshot will be created in.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The cluster snapshot identifier for the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-west-2 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks like the following example: <code>arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The URL that contains a Signature Version 4 signed request for the <code>CopyDBClusterSnapshot</code> API action in the AWS Region that contains the source cluster snapshot to copy. You must use the <code>PreSignedUrl</code> parameter when copying a cluster snapshot from another AWS Region.</p> <p>If you are using an AWS SDK tool or the AWS CLI, you can specify <code>SourceRegion</code> (or <code>--source-region</code> for the AWS CLI) instead of specifying <code>PreSignedUrl</code> manually. Specifying <code>SourceRegion</code> autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.</p> <p>The presigned URL must be a valid request for the <code>CopyDBClusterSnapshot</code> API action that can be executed in the source AWS Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:</p> <ul> <li> <p> <code>SourceRegion</code> - The ID of the region that contains the snapshot to be copied.</p> </li> <li> <p> <code>SourceDBClusterSnapshotIdentifier</code> - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 AWS Region, then your <code>SourceDBClusterSnapshotIdentifier</code> looks something like the following: <code>arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot</code>.</p> </li> <li> <p> <code>TargetDBClusterSnapshotIdentifier</code> - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.</p> </li> </ul>"
|
||||
},
|
||||
"CopyTags":{
|
||||
"shape":"BooleanOptional",
|
||||
|
|
@ -1028,7 +1028,7 @@
|
|||
"documentation":"<p>The tags to be assigned to the cluster snapshot.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input to <a>CopyDBClusterSnapshot</a>.</p>"
|
||||
"documentation":"<p>Represents the input to <a>CopyDBClusterSnapshot</a>. </p>"
|
||||
},
|
||||
"CopyDBClusterSnapshotResult":{
|
||||
"type":"structure",
|
||||
|
|
@ -1055,15 +1055,15 @@
|
|||
},
|
||||
"DBClusterIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cluster identifier. This parameter 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>my-cluster</code> </p>"
|
||||
"documentation":"<p>The cluster identifier. This parameter 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>my-cluster</code> </p>"
|
||||
},
|
||||
"DBClusterParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The name of the cluster parameter group to associate with this cluster.</p>"
|
||||
"documentation":"<p>The name of the cluster parameter group to associate with this cluster.</p>"
|
||||
},
|
||||
"VpcSecurityGroupIds":{
|
||||
"shape":"VpcSecurityGroupIdList",
|
||||
"documentation":"<p>A list of EC2 VPC security groups to associate with this cluster.</p>"
|
||||
"documentation":"<p>A list of EC2 VPC security groups to associate with this cluster. </p>"
|
||||
},
|
||||
"DBSubnetGroupName":{
|
||||
"shape":"String",
|
||||
|
|
@ -1083,7 +1083,7 @@
|
|||
},
|
||||
"MasterUsername":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the master user for the 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>"
|
||||
"documentation":"<p>The name of the master user for the 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",
|
||||
|
|
@ -1091,7 +1091,7 @@
|
|||
},
|
||||
"PreferredBackupWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The daily time range during which automated backups are created if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be 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 if automated backups are enabled using the <code>BackupRetentionPeriod</code> parameter. </p> <p>The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. </p> <p>Constraints:</p> <ul> <li> <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p> </li> <li> <p>Must be 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>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
|
|
@ -1107,18 +1107,18 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS KMS key identifier for an encrypted cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If an encryption key is not specified in <code>KmsKeyId</code>:</p> <ul> <li> <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. </p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is <code>true</code> and <code>ReplicationSourceIdentifier</code> is not specified, Amazon DocumentDB uses your default encryption key.</p> </li> </ul> <p>AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</p> <p>If you create a replica of an encrypted cluster in another AWS Region, you must set <code>KmsKeyId</code> to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.</p>"
|
||||
"documentation":"<p>The AWS KMS key identifier for an encrypted cluster.</p> <p>The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.</p> <p>If an encryption key is not specified in <code>KmsKeyId</code>: </p> <ul> <li> <p>If <code>ReplicationSourceIdentifier</code> identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key. </p> </li> <li> <p>If the <code>StorageEncrypted</code> parameter is <code>true</code> and <code>ReplicationSourceIdentifier</code> is not specified, Amazon DocumentDB uses your default encryption key. </p> </li> </ul> <p>AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.</p> <p>If you create a replica of an encrypted cluster in another AWS Region, you must set <code>KmsKeyId</code> to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.</p>"
|
||||
},
|
||||
"EnableCloudwatchLogsExports":{
|
||||
"shape":"LogTypeList",
|
||||
"documentation":"<p>A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.</p>"
|
||||
"documentation":"<p>A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html\"> Auditing Amazon DocumentDB Events</a> and <a href=\"https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html\"> Profiling Amazon DocumentDB Operations</a>. </p>"
|
||||
},
|
||||
"DeletionProtection":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input to <a>CreateDBCluster</a>.</p>"
|
||||
"documentation":"<p>Represents the input to <a>CreateDBCluster</a>. </p>"
|
||||
},
|
||||
"CreateDBClusterParameterGroupMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -1168,7 +1168,7 @@
|
|||
"members":{
|
||||
"DBClusterSnapshotIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the cluster snapshot. This parameter 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>my-cluster-snapshot1</code> </p>"
|
||||
"documentation":"<p>The identifier of the cluster snapshot. This parameter 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>my-cluster-snapshot1</code> </p>"
|
||||
},
|
||||
"DBClusterIdentifier":{
|
||||
"shape":"String",
|
||||
|
|
@ -1210,7 +1210,7 @@
|
|||
},
|
||||
"AvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The Amazon EC2 Availability Zone that the instance is created in.</p> <p>Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.</p> <p> Example: <code>us-east-1d</code> </p> <p> Constraint: The <code>AvailabilityZone</code> parameter can't be specified if the <code>MultiAZ</code> parameter is set to <code>true</code>. The specified Availability Zone must be in the same AWS Region as the current endpoint. </p>"
|
||||
"documentation":"<p>The Amazon EC2 Availability Zone that the instance is created in. </p> <p>Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.</p> <p>Example: <code>us-east-1d</code> </p>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
|
|
@ -3546,7 +3546,7 @@
|
|||
"documentation":"<p>A list that provides details about the pending maintenance actions for the resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of <a>ApplyPendingMaintenanceAction</a>.</p>",
|
||||
"documentation":"<p>Represents the output of <a>ApplyPendingMaintenanceAction</a>. </p>",
|
||||
"wrapper":true
|
||||
},
|
||||
"RestoreDBClusterFromSnapshotMessage":{
|
||||
|
|
|
|||
15
botocore/data/docdb/2014-10-31/service-2.sdk-extras.json
Normal file
15
botocore/data/docdb/2014-10-31/service-2.sdk-extras.json
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
{
|
||||
"version": 1.0,
|
||||
"merge": {
|
||||
"shapes": {
|
||||
"CopyDBClusterSnapshotMessage": {
|
||||
"members": {
|
||||
"SourceRegion": {
|
||||
"shape": "String",
|
||||
"documentation": "<p>The ID of the region that contains the snapshot to be copied.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -12,6 +12,25 @@
|
|||
"uid":"ebs-2019-11-02"
|
||||
},
|
||||
"operations":{
|
||||
"CompleteSnapshot":{
|
||||
"name":"CompleteSnapshot",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/snapshots/completion/{snapshotId}",
|
||||
"responseCode":202
|
||||
},
|
||||
"input":{"shape":"CompleteSnapshotRequest"},
|
||||
"output":{"shape":"CompleteSnapshotResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"RequestThrottledException"},
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to <code>completed</code>. You cannot write new blocks to a snapshot after it has been completed.</p>"
|
||||
},
|
||||
"GetSnapshotBlock":{
|
||||
"name":"GetSnapshotBlock",
|
||||
"http":{
|
||||
|
|
@ -21,8 +40,12 @@
|
|||
"input":{"shape":"GetSnapshotBlockRequest"},
|
||||
"output":{"shape":"GetSnapshotBlockResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"RequestThrottledException"},
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Returns the data in a block in an Amazon Elastic Block Store snapshot.</p>"
|
||||
},
|
||||
|
|
@ -35,8 +58,12 @@
|
|||
"input":{"shape":"ListChangedBlocksRequest"},
|
||||
"output":{"shape":"ListChangedBlocksResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"RequestThrottledException"},
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.</p>"
|
||||
},
|
||||
|
|
@ -49,13 +76,79 @@
|
|||
"input":{"shape":"ListSnapshotBlocksRequest"},
|
||||
"output":{"shape":"ListSnapshotBlocksResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"RequestThrottledException"},
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.</p>"
|
||||
},
|
||||
"PutSnapshotBlock":{
|
||||
"name":"PutSnapshotBlock",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/snapshots/{snapshotId}/blocks/{blockIndex}",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"PutSnapshotBlockRequest"},
|
||||
"output":{"shape":"PutSnapshotBlockResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"RequestThrottledException"},
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
],
|
||||
"documentation":"<p>Writes a block of data to a block in the snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the <code>pending</code> state.</p> <p>Data written to a snapshot must be aligned with 512-byte sectors.</p>",
|
||||
"authtype":"v4-unsigned-body"
|
||||
},
|
||||
"StartSnapshot":{
|
||||
"name":"StartSnapshot",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/snapshots",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"StartSnapshotRequest"},
|
||||
"output":{"shape":"StartSnapshotResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"RequestThrottledException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ServiceQuotaExceededException"},
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ConcurrentLimitExceededException"},
|
||||
{"shape":"ConflictException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new Amazon EBS snapshot. The new snapshot enters the <code>pending</code> state after the request completes. </p> <p>After creating the snapshot, use <a href=\"https://docs.aws.amazon.com/ebs/latest/APIReference/API_PutSnapshotBlock.html\"> PutSnapshotBlock</a> to write blocks of data to the snapshot.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessDeniedException":{
|
||||
"type":"structure",
|
||||
"required":["Reason"],
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"},
|
||||
"Reason":{
|
||||
"shape":"AccessDeniedExceptionReason",
|
||||
"documentation":"<p>The reason for the exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>You do not have sufficient access to perform this action.</p>",
|
||||
"error":{"httpStatusCode":403},
|
||||
"exception":true
|
||||
},
|
||||
"AccessDeniedExceptionReason":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"UNAUTHORIZED_ACCOUNT",
|
||||
"DEPENDENCY_ACCESS_DENIED"
|
||||
]
|
||||
},
|
||||
"Block":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -75,7 +168,10 @@
|
|||
"sensitive":true,
|
||||
"streaming":true
|
||||
},
|
||||
"BlockIndex":{"type":"integer"},
|
||||
"BlockIndex":{
|
||||
"type":"integer",
|
||||
"min":0
|
||||
},
|
||||
"BlockSize":{"type":"integer"},
|
||||
"BlockToken":{
|
||||
"type":"string",
|
||||
|
|
@ -87,6 +183,7 @@
|
|||
"member":{"shape":"Block"},
|
||||
"sensitive":true
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"ChangedBlock":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -110,16 +207,99 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"ChangedBlock"}
|
||||
},
|
||||
"ChangedBlocksCount":{
|
||||
"type":"integer",
|
||||
"min":0
|
||||
},
|
||||
"Checksum":{
|
||||
"type":"string",
|
||||
"max":64
|
||||
"max":64,
|
||||
"pattern":"^[A-Za-z0-9+/=]+$"
|
||||
},
|
||||
"ChecksumAggregationMethod":{
|
||||
"type":"string",
|
||||
"enum":["LINEAR"],
|
||||
"max":32,
|
||||
"pattern":"^[A-Za-z0-9]+$"
|
||||
},
|
||||
"ChecksumAlgorithm":{
|
||||
"type":"string",
|
||||
"enum":["SHA256"],
|
||||
"max":32
|
||||
"max":32,
|
||||
"pattern":"^[A-Za-z0-9]+$"
|
||||
},
|
||||
"CompleteSnapshotRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SnapshotId",
|
||||
"ChangedBlocksCount"
|
||||
],
|
||||
"members":{
|
||||
"SnapshotId":{
|
||||
"shape":"SnapshotId",
|
||||
"documentation":"<p>The ID of the snapshot.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"snapshotId"
|
||||
},
|
||||
"ChangedBlocksCount":{
|
||||
"shape":"ChangedBlocksCount",
|
||||
"documentation":"<p>The number of blocks that were written to the snapshot.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-ChangedBlocksCount"
|
||||
},
|
||||
"Checksum":{
|
||||
"shape":"Checksum",
|
||||
"documentation":"<p>An aggregated Base-64 SHA256 checksum based on the checksums of each written block.</p> <p>To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Checksum"
|
||||
},
|
||||
"ChecksumAlgorithm":{
|
||||
"shape":"ChecksumAlgorithm",
|
||||
"documentation":"<p>The algorithm used to generate the checksum. Currently, the only supported algorithm is <code>SHA256</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Checksum-Algorithm"
|
||||
},
|
||||
"ChecksumAggregationMethod":{
|
||||
"shape":"ChecksumAggregationMethod",
|
||||
"documentation":"<p>The aggregation method used to generate the checksum. Currently, the only supported aggregation method is <code>LINEAR</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Checksum-Aggregation-Method"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CompleteSnapshotResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Status":{
|
||||
"shape":"Status",
|
||||
"documentation":"<p>The status of the snapshot.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ConcurrentLimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>You have reached the limit for concurrent API requests. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapi-performance\">Optimizing performance of the EBS direct APIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"ConflictException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>The request uses the same client token as a previous, but non-identical request.</p>",
|
||||
"error":{"httpStatusCode":503},
|
||||
"exception":true
|
||||
},
|
||||
"DataLength":{"type":"integer"},
|
||||
"Description":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"pattern":"^[\\S\\s]+$"
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"type":"string",
|
||||
"max":256
|
||||
|
|
@ -180,6 +360,28 @@
|
|||
},
|
||||
"payload":"BlockData"
|
||||
},
|
||||
"IdempotencyToken":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"pattern":"^[\\S]+$"
|
||||
},
|
||||
"InternalServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>An internal error has occurred.</p>",
|
||||
"error":{"httpStatusCode":500},
|
||||
"exception":true,
|
||||
"fault":true
|
||||
},
|
||||
"KmsKeyArn":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":1,
|
||||
"pattern":"arn:aws[a-z\\-]*:kms:.*:[0-9]{12}:key/.*",
|
||||
"sensitive":true
|
||||
},
|
||||
"ListChangedBlocksRequest":{
|
||||
"type":"structure",
|
||||
"required":["SecondSnapshotId"],
|
||||
|
|
@ -301,27 +503,283 @@
|
|||
"max":10000,
|
||||
"min":100
|
||||
},
|
||||
"OwnerId":{
|
||||
"type":"string",
|
||||
"max":24,
|
||||
"min":1,
|
||||
"pattern":"\\S+"
|
||||
},
|
||||
"PageToken":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"pattern":"^[A-Za-z0-9+/=]+$"
|
||||
},
|
||||
"Progress":{
|
||||
"type":"integer",
|
||||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"PutSnapshotBlockRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SnapshotId",
|
||||
"BlockIndex",
|
||||
"BlockData",
|
||||
"DataLength",
|
||||
"Checksum",
|
||||
"ChecksumAlgorithm"
|
||||
],
|
||||
"members":{
|
||||
"SnapshotId":{
|
||||
"shape":"SnapshotId",
|
||||
"documentation":"<p>The ID of the snapshot.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"snapshotId"
|
||||
},
|
||||
"BlockIndex":{
|
||||
"shape":"BlockIndex",
|
||||
"documentation":"<p>The block index of the block in which to write the data. A block index is the offset position of a block within a snapshot, and it is used to identify the block. To identify the logical offset of the data in the logical volume, multiply the block index with the block size (Block index * 512 bytes).</p>",
|
||||
"location":"uri",
|
||||
"locationName":"blockIndex"
|
||||
},
|
||||
"BlockData":{
|
||||
"shape":"BlockData",
|
||||
"documentation":"<p>The data to write to the block.</p> <p>The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the <b>x-amz-Checksum</b> header. Also, you must specify the checksum algorithm using the <b>x-amz-Checksum-Algorithm</b> header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-checksums\"> Using checksums with the EBS direct APIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
},
|
||||
"DataLength":{
|
||||
"shape":"DataLength",
|
||||
"documentation":"<p>The size of the data to write to the block, in bytes. Currently, the only supported size is <code>524288</code>.</p> <p>Valid values: <code>524288</code> </p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Data-Length"
|
||||
},
|
||||
"Progress":{
|
||||
"shape":"Progress",
|
||||
"documentation":"<p>The progress of the write process, as a percentage.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Progress"
|
||||
},
|
||||
"Checksum":{
|
||||
"shape":"Checksum",
|
||||
"documentation":"<p>A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Checksum"
|
||||
},
|
||||
"ChecksumAlgorithm":{
|
||||
"shape":"ChecksumAlgorithm",
|
||||
"documentation":"<p>The algorithm used to generate the checksum. Currently, the only supported algorithm is <code>SHA256</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Checksum-Algorithm"
|
||||
}
|
||||
},
|
||||
"payload":"BlockData"
|
||||
},
|
||||
"PutSnapshotBlockResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Checksum":{
|
||||
"shape":"Checksum",
|
||||
"documentation":"<p>The SHA256 checksum generated for the block data by Amazon EBS.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Checksum"
|
||||
},
|
||||
"ChecksumAlgorithm":{
|
||||
"shape":"ChecksumAlgorithm",
|
||||
"documentation":"<p>The algorithm used by Amazon EBS to generate the checksum.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-Checksum-Algorithm"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RequestThrottledException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"},
|
||||
"Reason":{
|
||||
"shape":"RequestThrottledExceptionReason",
|
||||
"documentation":"<p>The reason for the exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The number of API requests has exceed the maximum allowed API request throttling limit.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"RequestThrottledExceptionReason":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ACCOUNT_THROTTLED",
|
||||
"DEPENDENCY_REQUEST_THROTTLED"
|
||||
]
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
"Message":{"shape":"ErrorMessage"},
|
||||
"Reason":{
|
||||
"shape":"ResourceNotFoundExceptionReason",
|
||||
"documentation":"<p>The reason for the exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The specified resource does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceNotFoundExceptionReason":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SNAPSHOT_NOT_FOUND",
|
||||
"DEPENDENCY_RESOURCE_NOT_FOUND"
|
||||
]
|
||||
},
|
||||
"ServiceQuotaExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"},
|
||||
"Reason":{
|
||||
"shape":"ServiceQuotaExceededExceptionReason",
|
||||
"documentation":"<p>The reason for the exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Your current service quotas do not allow you to perform this action.</p>",
|
||||
"error":{"httpStatusCode":402},
|
||||
"exception":true
|
||||
},
|
||||
"ServiceQuotaExceededExceptionReason":{
|
||||
"type":"string",
|
||||
"enum":["DEPENDENCY_SERVICE_QUOTA_EXCEEDED"]
|
||||
},
|
||||
"SnapshotId":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"^snap-[0-9a-f]+$"
|
||||
},
|
||||
"StartSnapshotRequest":{
|
||||
"type":"structure",
|
||||
"required":["VolumeSize"],
|
||||
"members":{
|
||||
"VolumeSize":{
|
||||
"shape":"VolumeSize",
|
||||
"documentation":"<p>The size of the volume, in GiB. The maximum size is <code>16384</code> GiB (16 TiB).</p>"
|
||||
},
|
||||
"ParentSnapshotId":{
|
||||
"shape":"SnapshotId",
|
||||
"documentation":"<p>The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.</p> <p>If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CopySnapshot.html\">CopySnapshot</a>.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The tags to apply to the snapshot.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p>A description for the snapshot.</p>"
|
||||
},
|
||||
"ClientToken":{
|
||||
"shape":"IdempotencyToken",
|
||||
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you do not specify a client token, one is automatically generated by the AWS SDK.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html\"> Idempotency for StartSnapshot API</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"Encrypted":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify <code>true</code>. To create an unencrypted snapshot, omit this parameter.</p> <p>If you specify a value for <b>ParentSnapshotId</b>, omit this parameter.</p> <p>If you specify <code>true</code>, the snapshot is encrypted using the CMK specified using the <b>KmsKeyArn</b> parameter. If no value is specified for <b>KmsKeyArn</b>, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyEbsDefaultKmsKeyId.html\"> ModifyEbsDefaultKmsKeyId</a>.</p> <p>If your account is enabled for encryption by default, you cannot set this parameter to <code>false</code>. In this case, you can omit this parameter.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html#ebsapis-using-encryption\"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
},
|
||||
"KmsKeyArn":{
|
||||
"shape":"KmsKeyArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.</p> <p>If you specify a <b>ParentSnapshotId</b>, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.</p> <p>If <b>Encrypted</b> is set to <code>true</code>, you must specify a CMK ARN. </p>"
|
||||
},
|
||||
"Timeout":{
|
||||
"shape":"Timeout",
|
||||
"documentation":"<p>The amount of time (in minutes) after which the snapshot is automatically cancelled if:</p> <ul> <li> <p>No blocks are written to the snapshot.</p> </li> <li> <p>The snapshot is not completed after writing the last block of data.</p> </li> </ul> <p>If no value is specified, the timeout defaults to <code>60</code> minutes.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartSnapshotResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
"documentation":"<p>The description of the snapshot.</p>"
|
||||
},
|
||||
"SnapshotId":{
|
||||
"shape":"SnapshotId",
|
||||
"documentation":"<p>The ID of the snapshot.</p>"
|
||||
},
|
||||
"OwnerId":{
|
||||
"shape":"OwnerId",
|
||||
"documentation":"<p>The AWS account ID of the snapshot owner.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"Status",
|
||||
"documentation":"<p>The status of the snapshot.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TimeStamp",
|
||||
"documentation":"<p>The timestamp when the snapshot was created.</p>"
|
||||
},
|
||||
"VolumeSize":{
|
||||
"shape":"VolumeSize",
|
||||
"documentation":"<p>The size of the volume, in GiB.</p>"
|
||||
},
|
||||
"BlockSize":{
|
||||
"shape":"BlockSize",
|
||||
"documentation":"<p>The size of the blocks in the snapshot, in bytes.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\"> Tagging your Amazon EC2 resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
},
|
||||
"ParentSnapshotId":{
|
||||
"shape":"SnapshotId",
|
||||
"documentation":"<p>The ID of the parent snapshot.</p>"
|
||||
},
|
||||
"KmsKeyArn":{
|
||||
"shape":"KmsKeyArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the snapshot.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Status":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"completed",
|
||||
"pending",
|
||||
"error"
|
||||
],
|
||||
"max":32
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p>The key of the tag.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p>The value of the tag.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a tag.</p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":127,
|
||||
"pattern":"^[\\S\\s]+$"
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"pattern":"^[\\S\\s]+$"
|
||||
},
|
||||
"Tags":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"}
|
||||
},
|
||||
"TimeStamp":{"type":"timestamp"},
|
||||
"Timeout":{
|
||||
"type":"integer",
|
||||
"max":60,
|
||||
"min":10
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -342,10 +800,19 @@
|
|||
"INVALID_PAGE_TOKEN",
|
||||
"INVALID_BLOCK_TOKEN",
|
||||
"INVALID_SNAPSHOT_ID",
|
||||
"UNRELATED_SNAPSHOTS"
|
||||
"UNRELATED_SNAPSHOTS",
|
||||
"INVALID_BLOCK",
|
||||
"INVALID_CONTENT_ENCODING",
|
||||
"INVALID_TAG",
|
||||
"INVALID_DEPENDENCY_REQUEST",
|
||||
"INVALID_PARAMETER_VALUE",
|
||||
"INVALID_VOLUME_SIZE"
|
||||
]
|
||||
},
|
||||
"VolumeSize":{"type":"long"}
|
||||
"VolumeSize":{
|
||||
"type":"long",
|
||||
"min":1
|
||||
}
|
||||
},
|
||||
"documentation":"<p>You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you’re an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.</p> <p>This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ebs-service.html\">Amazon Elastic Block Store Endpoints and Quotas</a> in the <i>AWS General Reference</i>.</p>"
|
||||
"documentation":"<p>You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you're an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.</p> <p>This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ebs-service.html\">Amazon Elastic Block Store Endpoints and Quotas</a> in the <i>AWS General Reference</i>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -523,6 +523,24 @@
|
|||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "MulticastGroups"
|
||||
},
|
||||
"DescribeManagedPrefixLists": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "PrefixLists"
|
||||
},
|
||||
"GetManagedPrefixListAssociations": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "PrefixListAssociations"
|
||||
},
|
||||
"GetManagedPrefixListEntries": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Entries"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -333,7 +333,8 @@
|
|||
{"shape":"LayersNotFoundException"},
|
||||
{"shape":"ReferencedImagesNotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ImageTagAlreadyExistsException"}
|
||||
{"shape":"ImageTagAlreadyExistsException"},
|
||||
{"shape":"ImageDigestDoesNotMatchException"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates the image manifest and tags associated with an image.</p> <p>When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.</p> <note> <p>This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
|
||||
},
|
||||
|
|
@ -1281,6 +1282,14 @@
|
|||
"member":{"shape":"ImageDetail"}
|
||||
},
|
||||
"ImageDigest":{"type":"string"},
|
||||
"ImageDigestDoesNotMatchException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>The specified image digest does not match the digest that Amazon ECR calculated for the image.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ImageFailure":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1909,6 +1918,10 @@
|
|||
"imageTag":{
|
||||
"shape":"ImageTag",
|
||||
"documentation":"<p>The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.</p>"
|
||||
},
|
||||
"imageDigest":{
|
||||
"shape":"ImageDigest",
|
||||
"documentation":"<p>The image digest of the image manifest corresponding to the image.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
|
|
@ -5,7 +5,13 @@
|
|||
{
|
||||
"input": {
|
||||
"CreationToken": "tokenstring",
|
||||
"PerformanceMode": "generalPurpose"
|
||||
"PerformanceMode": "generalPurpose",
|
||||
"Tags": [
|
||||
{
|
||||
"Key": "Name",
|
||||
"Value": "MyFileSystem"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"CreationTime": "1481841524.0",
|
||||
|
|
@ -17,7 +23,13 @@
|
|||
"PerformanceMode": "generalPurpose",
|
||||
"SizeInBytes": {
|
||||
"Value": 0
|
||||
}
|
||||
},
|
||||
"Tags": [
|
||||
{
|
||||
"Key": "Name",
|
||||
"Value": "MyFileSystem"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
|
|
@ -130,7 +142,13 @@
|
|||
"PerformanceMode": "generalPurpose",
|
||||
"SizeInBytes": {
|
||||
"Value": 6144
|
||||
}
|
||||
},
|
||||
"Tags": [
|
||||
{
|
||||
"Key": "Name",
|
||||
"Value": "MyFileSystem"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -141,6 +159,29 @@
|
|||
"title": "To describe an EFS file system"
|
||||
}
|
||||
],
|
||||
"DescribeLifecycleConfiguration": [
|
||||
{
|
||||
"input": {
|
||||
"FileSystemId": "fs-01234567"
|
||||
},
|
||||
"output": {
|
||||
"LifecyclePolicies": [
|
||||
{
|
||||
"TransitionToIA": "AFTER_30_DAYS"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. ",
|
||||
"id": "to-describe-the-lifecycle-configuration-for-a-file-system-1551200664502",
|
||||
"title": "To describe the lifecycle configuration for a file system"
|
||||
}
|
||||
],
|
||||
"DescribeMountTargetSecurityGroups": [
|
||||
{
|
||||
"input": {
|
||||
|
|
@ -148,7 +189,7 @@
|
|||
},
|
||||
"output": {
|
||||
"SecurityGroups": [
|
||||
"sg-fghi4567"
|
||||
"sg-4567abcd"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
|
|
@ -217,6 +258,34 @@
|
|||
"id": "to-modify-the-security-groups-associated-with-a-mount-target-for-a-file-system-1481850772562",
|
||||
"title": "To modify the security groups associated with a mount target for a file system"
|
||||
}
|
||||
],
|
||||
"PutLifecycleConfiguration": [
|
||||
{
|
||||
"input": {
|
||||
"FileSystemId": "fs-01234567",
|
||||
"LifecyclePolicies": [
|
||||
{
|
||||
"TransitionToIA": "AFTER_30_DAYS"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"LifecyclePolicies": [
|
||||
{
|
||||
"TransitionToIA": "AFTER_30_DAYS"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.",
|
||||
"id": "creates-a-new-lifecycleconfiguration-object-for-a-file-system-1551201594692",
|
||||
"title": "Creates a new lifecycleconfiguration object for a file system"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -23,6 +23,7 @@
|
|||
"errors":[
|
||||
{"shape":"BadRequest"},
|
||||
{"shape":"AccessPointAlreadyExists"},
|
||||
{"shape":"IncorrectFileSystemLifeCycleState"},
|
||||
{"shape":"InternalServerError"},
|
||||
{"shape":"FileSystemNotFound"},
|
||||
{"shape":"AccessPointLimitExceeded"}
|
||||
|
|
@ -186,6 +187,24 @@
|
|||
],
|
||||
"documentation":"<p>Returns the description of a specific Amazon EFS access point if the <code>AccessPointId</code> is provided. If you provide an EFS <code>FileSystemId</code>, it returns descriptions of all access points for that file system. You can provide either an <code>AccessPointId</code> or a <code>FileSystemId</code> in the request, but not both. </p> <p>This operation requires permissions for the <code>elasticfilesystem:DescribeAccessPoints</code> action.</p>"
|
||||
},
|
||||
"DescribeBackupPolicy":{
|
||||
"name":"DescribeBackupPolicy",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2015-02-01/file-systems/{FileSystemId}/backup-policy",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"DescribeBackupPolicyRequest"},
|
||||
"output":{"shape":"BackupPolicyDescription"},
|
||||
"errors":[
|
||||
{"shape":"BadRequest"},
|
||||
{"shape":"FileSystemNotFound"},
|
||||
{"shape":"InternalServerError"},
|
||||
{"shape":"PolicyNotFound"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Returns the backup policy for the specified EFS file system.</p>"
|
||||
},
|
||||
"DescribeFileSystemPolicy":{
|
||||
"name":"DescribeFileSystemPolicy",
|
||||
"http":{
|
||||
|
|
@ -322,6 +341,24 @@
|
|||
],
|
||||
"documentation":"<p>Modifies the set of security groups in effect for a mount target.</p> <p>When you create a mount target, Amazon EFS also creates a new network interface. For more information, see <a>CreateMountTarget</a>. This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not <code>deleted</code>. </p> <p>The operation requires permissions for the following actions:</p> <ul> <li> <p> <code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </p> </li> <li> <p> <code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </p> </li> </ul>"
|
||||
},
|
||||
"PutBackupPolicy":{
|
||||
"name":"PutBackupPolicy",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/2015-02-01/file-systems/{FileSystemId}/backup-policy",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"PutBackupPolicyRequest"},
|
||||
"output":{"shape":"BackupPolicyDescription"},
|
||||
"errors":[
|
||||
{"shape":"BadRequest"},
|
||||
{"shape":"FileSystemNotFound"},
|
||||
{"shape":"IncorrectFileSystemLifeCycleState"},
|
||||
{"shape":"InternalServerError"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system. </p>"
|
||||
},
|
||||
"PutFileSystemPolicy":{
|
||||
"name":"PutFileSystemPolicy",
|
||||
"http":{
|
||||
|
|
@ -501,7 +538,31 @@
|
|||
},
|
||||
"AvailabilityZoneId":{"type":"string"},
|
||||
"AvailabilityZoneName":{"type":"string"},
|
||||
"AwsAccountId":{"type":"string"},
|
||||
"AwsAccountId":{
|
||||
"type":"string",
|
||||
"max":14,
|
||||
"pattern":"^(\\d{12})|(\\d{4}-\\d{4}-\\d{4})$"
|
||||
},
|
||||
"BackupPolicy":{
|
||||
"type":"structure",
|
||||
"required":["Status"],
|
||||
"members":{
|
||||
"Status":{
|
||||
"shape":"Status",
|
||||
"documentation":"<p>Describes the status of the file system's backup policy.</p> <ul> <li> <p> <i> <code>ENABLED</code> - EFS is automatically backing up the file system.</i> </p> </li> <li> <p> <i> <code>ENABLING</code> - EFS is turning on automatic backups for the file system.</i> </p> </li> <li> <p> <i> <code>DISABLED</code> - automatic back ups are turned off for the file system.</i> </p> </li> <li> <p> <i> <code>DISABLED</code> - EFS is turning off automatic backups for the file system.</i> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The backup policy for the file system, showing the curent status. If <code>ENABLED</code>, the file system is being backed up.</p>"
|
||||
},
|
||||
"BackupPolicyDescription":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"BackupPolicy":{
|
||||
"shape":"BackupPolicy",
|
||||
"documentation":"<p>Describes the file system's backup policy, indicating whether automatic backups are turned on or off..</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BadRequest":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
|
|
@ -656,7 +717,8 @@
|
|||
"CreationToken":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1
|
||||
"min":1,
|
||||
"pattern":".+"
|
||||
},
|
||||
"DeleteAccessPointRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -781,6 +843,18 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DescribeBackupPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":["FileSystemId"],
|
||||
"members":{
|
||||
"FileSystemId":{
|
||||
"shape":"FileSystemId",
|
||||
"documentation":"<p>Specifies which EFS file system to retrieve the <code>BackupPolicy</code> for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"FileSystemId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeFileSystemPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":["FileSystemId"],
|
||||
|
|
@ -994,6 +1068,7 @@
|
|||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"FileSystemArn":{"type":"string"},
|
||||
"FileSystemDescription":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1020,6 +1095,10 @@
|
|||
"shape":"FileSystemId",
|
||||
"documentation":"<p>The ID of the file system, assigned by Amazon EFS.</p>"
|
||||
},
|
||||
"FileSystemArn":{
|
||||
"shape":"FileSystemArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the EFS file system, in the format <code>arn:aws:elasticfilesystem:<i>region</i>:<i>account-id</i>:file-system/<i>file-system-id</i> </code>. Example with sample data: <code>arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567</code> </p>"
|
||||
},
|
||||
"CreationTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).</p>"
|
||||
|
|
@ -1071,7 +1150,11 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"FileSystemDescription"}
|
||||
},
|
||||
"FileSystemId":{"type":"string"},
|
||||
"FileSystemId":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$"
|
||||
},
|
||||
"FileSystemInUse":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
|
|
@ -1208,7 +1291,12 @@
|
|||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"IpAddress":{"type":"string"},
|
||||
"IpAddress":{
|
||||
"type":"string",
|
||||
"max":15,
|
||||
"min":7,
|
||||
"pattern":"^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$"
|
||||
},
|
||||
"IpAddressInUse":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
|
|
@ -1223,7 +1311,7 @@
|
|||
"KmsKeyId":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":1
|
||||
"pattern":"^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(alias/[a-zA-Z0-9/_-]+))))$"
|
||||
},
|
||||
"LifeCycleState":{
|
||||
"type":"string",
|
||||
|
|
@ -1295,7 +1383,12 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"Marker":{"type":"string"},
|
||||
"Marker":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":".+"
|
||||
},
|
||||
"MaxItems":{
|
||||
"type":"integer",
|
||||
"min":1
|
||||
|
|
@ -1380,6 +1473,10 @@
|
|||
"AvailabilityZoneName":{
|
||||
"shape":"AvailabilityZoneName",
|
||||
"documentation":"<p>The name of the Availability Zone (AZ) that the mount target resides in. AZs are independently mapped to names for each AWS account. For example, the Availability Zone <code>us-east-1a</code> for your AWS account might not be the same location as <code>us-east-1a</code> for another AWS account.</p>"
|
||||
},
|
||||
"VpcId":{
|
||||
"shape":"VpcId",
|
||||
"documentation":"<p>The Virtual Private Cloud (VPC) ID that the mount target is configured in.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides a description of a mount target.</p>"
|
||||
|
|
@ -1388,7 +1485,12 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"MountTargetDescription"}
|
||||
},
|
||||
"MountTargetId":{"type":"string"},
|
||||
"MountTargetId":{
|
||||
"type":"string",
|
||||
"max":45,
|
||||
"min":13,
|
||||
"pattern":"^fsmt-[0-9a-f]{8,40}$"
|
||||
},
|
||||
"MountTargetNotFound":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
|
|
@ -1487,6 +1589,25 @@
|
|||
"type":"double",
|
||||
"min":1.0
|
||||
},
|
||||
"PutBackupPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"FileSystemId",
|
||||
"BackupPolicy"
|
||||
],
|
||||
"members":{
|
||||
"FileSystemId":{
|
||||
"shape":"FileSystemId",
|
||||
"documentation":"<p>Specifies which EFS file system to update the backup policy for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"FileSystemId"
|
||||
},
|
||||
"BackupPolicy":{
|
||||
"shape":"BackupPolicy",
|
||||
"documentation":"<p>The backup policy included in the <code>PutBackupPolicy</code> request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutFileSystemPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1550,7 +1671,12 @@
|
|||
"max":16,
|
||||
"min":0
|
||||
},
|
||||
"SecurityGroup":{"type":"string"},
|
||||
"SecurityGroup":{
|
||||
"type":"string",
|
||||
"max":43,
|
||||
"min":11,
|
||||
"pattern":"^sg-[0-9a-f]{8,40}"
|
||||
},
|
||||
"SecurityGroupLimitExceeded":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
|
|
@ -1578,7 +1704,21 @@
|
|||
"member":{"shape":"SecurityGroup"},
|
||||
"max":5
|
||||
},
|
||||
"SubnetId":{"type":"string"},
|
||||
"Status":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ENABLED",
|
||||
"ENABLING",
|
||||
"DISABLED",
|
||||
"DISABLING"
|
||||
]
|
||||
},
|
||||
"SubnetId":{
|
||||
"type":"string",
|
||||
"max":47,
|
||||
"min":15,
|
||||
"pattern":"^subnet-[0-9a-f]{8,40}$"
|
||||
},
|
||||
"SubnetNotFound":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
|
|
@ -1611,7 +1751,8 @@
|
|||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1
|
||||
"min":1,
|
||||
"pattern":"^(?![aA]{1}[wW]{1}[sS]{1}:)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$"
|
||||
},
|
||||
"TagKeys":{
|
||||
"type":"list",
|
||||
|
|
@ -1640,7 +1781,8 @@
|
|||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256
|
||||
"max":256,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"Tags":{
|
||||
"type":"list",
|
||||
|
|
@ -1743,7 +1885,19 @@
|
|||
"documentation":"<p>(Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are 1-1024. Required if <code>ThroughputMode</code> is changed to <code>provisioned</code> on update. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
"members":{
|
||||
"ErrorCode":{"shape":"ErrorCode"},
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Returned if the AWS Backup service is not available in the region that the request was made.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"VpcId":{"type":"string"}
|
||||
},
|
||||
"documentation":"<fullname>Amazon Elastic File System</fullname> <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the <a href=\"https://docs.aws.amazon.com/efs/latest/ug/api-reference.html\">User Guide</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -260,7 +260,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.</p> <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.</p> <p>A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).</p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-restoring.html\">Restoring From a Backup with Cluster Resizing</a> in the <i>ElastiCache User Guide</i>.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
"documentation":"<p>Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.</p> <p>This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.</p> <p>A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.</p> <p>A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).</p> <p>When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html\">Scaling ElastiCache for Redis Clusters</a> in the <i>ElastiCache User Guide</i>.</p> <note> <p>This operation is valid for Redis only.</p> </note>"
|
||||
},
|
||||
"CreateSnapshot":{
|
||||
"name":"CreateSnapshot",
|
||||
|
|
@ -1129,7 +1129,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).</p> <p class=\"title\"> <b>Note the following</b> </p> <ul> <li> <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.</p> </li> <li> <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p> <p> </p> </li> <li> <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.</p> </li> <li> <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:</p> <ol> <li> <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code> </p> </li> <li> <p>Cache cluster message: <code>Failover from master node <primary-node-id> to replica node <node-id> completed</code> </p> </li> <li> <p>Replication group message: <code>Failover from master node <primary-node-id> to replica node <node-id> completed</code> </p> </li> <li> <p>Cache cluster message: <code>Recovering cache nodes <node-id></code> </p> </li> <li> <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code> </p> </li> </ol> <p>For more information see:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing ElastiCache Events</a> in the <i>ElastiCache User Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p> </li> </ul> </li> </ul> <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing Multi-AZ with Automatic Failover</a> in the <i>ElastiCache User Guide</i>.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>TestFailover</code> operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).</p> <p class=\"title\"> <b>Note the following</b> </p> <ul> <li> <p>A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.</p> </li> <li> <p>If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.</p> <p> </p> </li> <li> <p>If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.</p> </li> <li> <p>To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:</p> <ol> <li> <p>Replication group message: <code>Test Failover API called for node group <node-group-id></code> </p> </li> <li> <p>Cache cluster message: <code>Failover from master node <primary-node-id> to replica node <node-id> completed</code> </p> </li> <li> <p>Replication group message: <code>Failover from master node <primary-node-id> to replica node <node-id> completed</code> </p> </li> <li> <p>Cache cluster message: <code>Recovering cache nodes <node-id></code> </p> </li> <li> <p>Cache cluster message: <code>Finished recovery for cache nodes <node-id></code> </p> </li> </ol> <p>For more information see:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.Viewing.html\">Viewing ElastiCache Events</a> in the <i>ElastiCache User Guide</i> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a> in the ElastiCache API Reference</p> </li> </ul> </li> </ul> <p>Also see, <a href=\"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html#auto-failover-test\">Testing Multi-AZ </a> in the <i>ElastiCache User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -2104,7 +2104,7 @@
|
|||
},
|
||||
"NewReplicaCount":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of replicas you want in this node group at the end of this operation. The maximum value for <code>NewReplicaCount</code> is 5. The minimum value depends upon the type of Redis replication group you are working with.</p> <p>The minimum number of replicas in a shard or replication group is:</p> <ul> <li> <p>Redis (cluster mode disabled)</p> <ul> <li> <p>If Multi-AZ with Automatic Failover is enabled: 1</p> </li> <li> <p>If Multi-AZ with Automatic Failover is not enable: 0</p> </li> </ul> </li> <li> <p>Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p> </li> </ul>"
|
||||
"documentation":"<p>The number of replicas you want in this node group at the end of this operation. The maximum value for <code>NewReplicaCount</code> is 5. The minimum value depends upon the type of Redis replication group you are working with.</p> <p>The minimum number of replicas in a shard or replication group is:</p> <ul> <li> <p>Redis (cluster mode disabled)</p> <ul> <li> <p>If Multi-AZ: 1</p> </li> <li> <p>If Multi-AZ: 0</p> </li> </ul> </li> <li> <p>Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p> </li> </ul>"
|
||||
},
|
||||
"PreferredAvailabilityZones":{
|
||||
"shape":"PreferredAvailabilityZoneList",
|
||||
|
|
@ -2384,7 +2384,7 @@
|
|||
},
|
||||
"AutomaticFailoverEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.</p> <p> <code>AutomaticFailoverEnabled</code> must be enabled for Redis (cluster mode enabled) replication groups.</p> <p>Default: false</p> <p>Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled): T1 node types.</p> </li> <li> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul>"
|
||||
"documentation":"<p>Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.</p> <p> <code>AutomaticFailoverEnabled</code> must be enabled for Redis (cluster mode enabled) replication groups.</p> <p>Default: false</p>"
|
||||
},
|
||||
"MultiAZEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
|
|
@ -2595,7 +2595,7 @@
|
|||
},
|
||||
"NewReplicaCount":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.</p> <p>The minimum number of replicas in a shard or replication group is:</p> <ul> <li> <p>Redis (cluster mode disabled)</p> <ul> <li> <p>If Multi-AZ with Automatic Failover is enabled: 1</p> </li> <li> <p>If Multi-AZ with Automatic Failover is not enabled: 0</p> </li> </ul> </li> <li> <p>Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p> </li> </ul>"
|
||||
"documentation":"<p>The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.</p> <p>The minimum number of replicas in a shard or replication group is:</p> <ul> <li> <p>Redis (cluster mode disabled)</p> <ul> <li> <p>If Multi-AZ is enabled: 1</p> </li> <li> <p>If Multi-AZ is not enabled: 0</p> </li> </ul> </li> <li> <p>Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)</p> </li> </ul>"
|
||||
},
|
||||
"ReplicaConfiguration":{
|
||||
"shape":"ReplicaConfigurationList",
|
||||
|
|
@ -3947,7 +3947,7 @@
|
|||
},
|
||||
"AutomaticFailoverEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.</p> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled): T1 node types.</p> </li> <li> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul>"
|
||||
"documentation":"<p>Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.</p> <p>Valid values: <code>true</code> | <code>false</code> </p>"
|
||||
},
|
||||
"MultiAZEnabled":{
|
||||
"shape":"BooleanOptional",
|
||||
|
|
@ -4725,7 +4725,7 @@
|
|||
},
|
||||
"AutomaticFailover":{
|
||||
"shape":"AutomaticFailoverStatus",
|
||||
"documentation":"<p>Indicates the status of Multi-AZ with automatic failover for this Redis replication group.</p> <p>Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled): T1 node types.</p> </li> <li> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul>"
|
||||
"documentation":"<p>Indicates the status of automatic failover for this Redis replication group.</p>"
|
||||
},
|
||||
"MultiAZ":{
|
||||
"shape":"MultiAZStatus",
|
||||
|
|
@ -4862,7 +4862,7 @@
|
|||
},
|
||||
"AutomaticFailoverStatus":{
|
||||
"shape":"PendingAutomaticFailoverStatus",
|
||||
"documentation":"<p>Indicates the status of Multi-AZ with automatic failover for this Redis replication group.</p> <p>Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled): T1 node types.</p> </li> <li> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul>"
|
||||
"documentation":"<p>Indicates the status of automatic failover for this Redis replication group.</p>"
|
||||
},
|
||||
"Resharding":{
|
||||
"shape":"ReshardingStatus",
|
||||
|
|
@ -5402,7 +5402,7 @@
|
|||
},
|
||||
"AutomaticFailover":{
|
||||
"shape":"AutomaticFailoverStatus",
|
||||
"documentation":"<p>Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.</p> <p>Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:</p> <ul> <li> <p>Redis versions earlier than 2.8.6.</p> </li> <li> <p>Redis (cluster mode disabled): T1 node types.</p> </li> <li> <p>Redis (cluster mode enabled): T1 node types.</p> </li> </ul>"
|
||||
"documentation":"<p>Indicates the status of automatic failover for the source Redis replication group.</p>"
|
||||
},
|
||||
"NodeSnapshots":{
|
||||
"shape":"NodeSnapshotList",
|
||||
|
|
|
|||
|
|
@ -1769,14 +1769,17 @@
|
|||
},
|
||||
"InstanceFleetProvisioningSpecifications":{
|
||||
"type":"structure",
|
||||
"required":["SpotSpecification"],
|
||||
"members":{
|
||||
"SpotSpecification":{
|
||||
"shape":"SpotProvisioningSpecification",
|
||||
"documentation":"<p>The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.</p>"
|
||||
"documentation":"<p>The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.</p>"
|
||||
},
|
||||
"OnDemandSpecification":{
|
||||
"shape":"OnDemandProvisioningSpecification",
|
||||
"documentation":"<p> The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy. </p> <note> <p>The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand instances allocation strategy is available in Amazon EMR version 5.12.1 and later.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.</p> <note> <p>The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.</p> </note>"
|
||||
"documentation":"<p>The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.</p> <note> <p>The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation strategies are available in Amazon EMR version 5.12.1 and later.</p> </note>"
|
||||
},
|
||||
"InstanceFleetState":{
|
||||
"type":"string",
|
||||
|
|
@ -3044,6 +3047,21 @@
|
|||
"type":"double",
|
||||
"min":0.0
|
||||
},
|
||||
"OnDemandProvisioningAllocationStrategy":{
|
||||
"type":"string",
|
||||
"enum":["lowest-price"]
|
||||
},
|
||||
"OnDemandProvisioningSpecification":{
|
||||
"type":"structure",
|
||||
"required":["AllocationStrategy"],
|
||||
"members":{
|
||||
"AllocationStrategy":{
|
||||
"shape":"OnDemandProvisioningAllocationStrategy",
|
||||
"documentation":"<p> Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price (the default), which launches the lowest price first. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy. </p> <note> <p>The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand instances allocation strategy is available in Amazon EMR version 5.12.1 and later.</p> </note>"
|
||||
},
|
||||
"OptionalArnType":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
|
|
@ -3552,6 +3570,10 @@
|
|||
},
|
||||
"documentation":"<p>An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.</p>"
|
||||
},
|
||||
"SpotProvisioningAllocationStrategy":{
|
||||
"type":"string",
|
||||
"enum":["capacity-optimized"]
|
||||
},
|
||||
"SpotProvisioningSpecification":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3570,9 +3592,13 @@
|
|||
"BlockDurationMinutes":{
|
||||
"shape":"WholeNumber",
|
||||
"documentation":"<p>The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. </p>"
|
||||
},
|
||||
"AllocationStrategy":{
|
||||
"shape":"SpotProvisioningAllocationStrategy",
|
||||
"documentation":"<p> Specifies the strategy to use in launching Spot instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot instance pools with optimal capacity for the number of instances that are launching. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The launch specification for Spot instances in the instance fleet, which determines the defined duration and provisioning timeout behavior.</p> <note> <p>The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.</p> </note>"
|
||||
"documentation":"<p>The launch specification for Spot instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.</p> <note> <p>The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Spot instance allocation strategy is available in Amazon EMR version 5.12.1 and later.</p> </note>"
|
||||
},
|
||||
"SpotProvisioningTimeoutAction":{
|
||||
"type":"string",
|
||||
|
|
|
|||
|
|
@ -554,6 +554,7 @@
|
|||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"eu-central-1" : { },
|
||||
|
|
@ -575,11 +576,16 @@
|
|||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"ca-central-1" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-north-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-1" : { },
|
||||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
|
|
@ -2444,6 +2450,7 @@
|
|||
"protocols" : [ "https" ]
|
||||
},
|
||||
"endpoints" : {
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
|
|
@ -2545,6 +2552,7 @@
|
|||
},
|
||||
"hostname" : "fms-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
|
|
@ -2804,6 +2812,11 @@
|
|||
"us-east-1" : { }
|
||||
}
|
||||
},
|
||||
"honeycode" : {
|
||||
"endpoints" : {
|
||||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
"iam" : {
|
||||
"endpoints" : {
|
||||
"aws-global" : {
|
||||
|
|
@ -3367,6 +3380,51 @@
|
|||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
"macie2" : {
|
||||
"endpoints" : {
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"ca-central-1" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-north-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
"fips-us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "macie2-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "macie2-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "macie2-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"fips-us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "macie2-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-1" : { },
|
||||
"us-west-2" : { }
|
||||
}
|
||||
},
|
||||
"managedblockchain" : {
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
|
|
@ -3550,6 +3608,7 @@
|
|||
}
|
||||
},
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"eu-central-1" : { },
|
||||
|
|
@ -3751,6 +3810,12 @@
|
|||
},
|
||||
"hostname" : "rds.us-east-2.amazonaws.com"
|
||||
},
|
||||
"us-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "rds.us-west-1.amazonaws.com"
|
||||
},
|
||||
"us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
|
|
@ -3869,9 +3934,11 @@
|
|||
},
|
||||
"outposts" : {
|
||||
"endpoints" : {
|
||||
"af-south-1" : { },
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
"ap-south-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"ca-central-1" : { },
|
||||
|
|
@ -3911,6 +3978,7 @@
|
|||
"hostname" : "outposts-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"me-south-1" : { },
|
||||
"sa-east-1" : { },
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-1" : { },
|
||||
|
|
@ -4084,6 +4152,7 @@
|
|||
},
|
||||
"ram" : {
|
||||
"endpoints" : {
|
||||
"af-south-1" : { },
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
|
|
@ -4093,6 +4162,7 @@
|
|||
"ca-central-1" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-north-1" : { },
|
||||
"eu-south-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
|
|
@ -4224,6 +4294,30 @@
|
|||
"eu-central-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"rekognition-fips.us-east-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-1"
|
||||
},
|
||||
"hostname" : "rekognition-fips.us-east-1.amazonaws.com"
|
||||
},
|
||||
"rekognition-fips.us-east-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-east-2"
|
||||
},
|
||||
"hostname" : "rekognition-fips.us-east-2.amazonaws.com"
|
||||
},
|
||||
"rekognition-fips.us-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-1"
|
||||
},
|
||||
"hostname" : "rekognition-fips.us-west-1.amazonaws.com"
|
||||
},
|
||||
"rekognition-fips.us-west-2" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-west-2"
|
||||
},
|
||||
"hostname" : "rekognition-fips.us-west-2.amazonaws.com"
|
||||
},
|
||||
"us-east-1" : { },
|
||||
"us-east-2" : { },
|
||||
"us-west-1" : { },
|
||||
|
|
@ -4311,6 +4405,7 @@
|
|||
"protocols" : [ "https" ]
|
||||
},
|
||||
"endpoints" : {
|
||||
"af-south-1" : { },
|
||||
"ap-east-1" : { },
|
||||
"ap-northeast-1" : { },
|
||||
"ap-northeast-2" : { },
|
||||
|
|
@ -4320,6 +4415,7 @@
|
|||
"ca-central-1" : { },
|
||||
"eu-central-1" : { },
|
||||
"eu-north-1" : { },
|
||||
"eu-south-1" : { },
|
||||
"eu-west-1" : { },
|
||||
"eu-west-2" : { },
|
||||
"eu-west-3" : { },
|
||||
|
|
@ -4338,6 +4434,7 @@
|
|||
}
|
||||
},
|
||||
"endpoints" : {
|
||||
"ap-northeast-1" : { },
|
||||
"ap-southeast-1" : { },
|
||||
"ap-southeast-2" : { },
|
||||
"eu-central-1" : { },
|
||||
|
|
@ -6074,6 +6171,18 @@
|
|||
"isRegionalized" : false,
|
||||
"partitionEndpoint" : "aws-cn-global"
|
||||
},
|
||||
"ce" : {
|
||||
"endpoints" : {
|
||||
"aws-cn-global" : {
|
||||
"credentialScope" : {
|
||||
"region" : "cn-northwest-1"
|
||||
},
|
||||
"hostname" : "ce.cn-northwest-1.amazonaws.com.cn"
|
||||
}
|
||||
},
|
||||
"isRegionalized" : false,
|
||||
"partitionEndpoint" : "aws-cn-global"
|
||||
},
|
||||
"cloudformation" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { },
|
||||
|
|
@ -6397,6 +6506,24 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"organizations" : {
|
||||
"endpoints" : {
|
||||
"aws-cn-global" : {
|
||||
"credentialScope" : {
|
||||
"region" : "cn-northwest-1"
|
||||
},
|
||||
"hostname" : "organizations.cn-northwest-1.amazonaws.com.cn"
|
||||
},
|
||||
"fips-aws-cn-global" : {
|
||||
"credentialScope" : {
|
||||
"region" : "cn-northwest-1"
|
||||
},
|
||||
"hostname" : "organizations.cn-northwest-1.amazonaws.com.cn"
|
||||
}
|
||||
},
|
||||
"isRegionalized" : false,
|
||||
"partitionEndpoint" : "aws-cn-global"
|
||||
},
|
||||
"polly" : {
|
||||
"endpoints" : {
|
||||
"cn-northwest-1" : { }
|
||||
|
|
@ -6492,11 +6619,18 @@
|
|||
"snowball" : {
|
||||
"endpoints" : {
|
||||
"cn-north-1" : { },
|
||||
"cn-northwest-1" : { },
|
||||
"fips-cn-north-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "cn-north-1"
|
||||
},
|
||||
"hostname" : "snowball-fips.cn-north-1.amazonaws.com.cn"
|
||||
},
|
||||
"fips-cn-northwest-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "cn-northwest-1"
|
||||
},
|
||||
"hostname" : "snowball-fips.cn-northwest-1.amazonaws.com.cn"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -6775,6 +6909,12 @@
|
|||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"backup" : {
|
||||
"endpoints" : {
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"batch" : {
|
||||
"endpoints" : {
|
||||
"fips-us-gov-east-1" : {
|
||||
|
|
@ -6937,6 +7077,12 @@
|
|||
},
|
||||
"comprehendmedical" : {
|
||||
"endpoints" : {
|
||||
"fips-us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "comprehendmedical-fips.us-gov-west-1.amazonaws.com"
|
||||
},
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
|
|
@ -7003,6 +7149,16 @@
|
|||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"docdb" : {
|
||||
"endpoints" : {
|
||||
"us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "rds.us-gov-west-1.amazonaws.com"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ds" : {
|
||||
"endpoints" : {
|
||||
"fips-us-gov-east-1" : {
|
||||
|
|
@ -7369,6 +7525,12 @@
|
|||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"kinesisanalytics" : {
|
||||
"endpoints" : {
|
||||
"us-gov-east-1" : { },
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
"kms" : {
|
||||
"endpoints" : {
|
||||
"ProdFips" : {
|
||||
|
|
@ -7585,6 +7747,12 @@
|
|||
},
|
||||
"rekognition" : {
|
||||
"endpoints" : {
|
||||
"rekognition-fips.us-gov-west-1" : {
|
||||
"credentialScope" : {
|
||||
"region" : "us-gov-west-1"
|
||||
},
|
||||
"hostname" : "rekognition-fips.us-gov-west-1.amazonaws.com"
|
||||
},
|
||||
"us-gov-west-1" : { }
|
||||
}
|
||||
},
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -26,7 +26,7 @@
|
|||
{"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.</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 in the dataset, including the field name and data type.</p> </li> </ul> <p>After creating a dataset, you import your training data into it and add the dataset to a dataset group. You 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> <p>For example Forecast datasets, see the <a href=\"https://github.com/aws-samples/amazon-forecast-samples/tree/master/data\">Amazon Forecast Sample GitHub repository</a>.</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>"
|
||||
"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.</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 in the dataset, including the field name and data type.</p> </li> </ul> <p>After creating a dataset, you import your training data into it and add the dataset to a dataset group. You 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> <p>For example Forecast datasets, see the <a href=\"https://github.com/aws-samples/amazon-forecast-samples\">Amazon Forecast Sample GitHub repository</a>.</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",
|
||||
|
|
@ -60,7 +60,7 @@
|
|||
{"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>The training data must be in CSV format. The delimiter must be a comma (,).</p> <p>You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.</p> <p>To get a list of all your dataset import jobs, filtered by specified criteria, use the <a>ListDatasetImportJobs</a> operation.</p>"
|
||||
"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, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see <a>aws-forecast-iam-roles</a>.</p> <p>The training data must be in CSV format. The delimiter must be a comma (,).</p> <p>You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.</p> <p>Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.</p> <p>To get a list of all your dataset import jobs, filtered by specified criteria, use the <a>ListDatasetImportJobs</a> operation.</p>"
|
||||
},
|
||||
"CreateForecast":{
|
||||
"name":"CreateForecast",
|
||||
|
|
@ -77,7 +77,7 @@
|
|||
{"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) bucket, use the <a>CreateForecastExportJob</a> operation.</p> <p>The range of the forecast is determined by the <code>ForecastHorizon</code> value, which you specify in the <a>CreatePredictor</a> request, multiplied by the <code>DataFrequency</code> value, which you specify in the <a>CreateDataset</a> request. When you query a forecast, you can request a specific date range within the 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 time zone 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>"
|
||||
"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) bucket, use the <a>CreateForecastExportJob</a> operation.</p> <p>The range of the forecast is determined by the <code>ForecastHorizon</code> value, which you specify in the <a>CreatePredictor</a> request. When you query a forecast, you can request a specific date range within the 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 time zone 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",
|
||||
|
|
@ -94,7 +94,7 @@
|
|||
{"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. The forecast file name will match the following conventions:</p> <p><ForecastExportJobName>_<ExportTimestamp>_<PageNumber></p> <p>where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).</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. To get the status, use the <a>DescribeForecastExportJob</a> operation.</p> </note>"
|
||||
"documentation":"<p>Exports a forecast created by the <a>CreateForecast</a> operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:</p> <p><ForecastExportJobName>_<ExportTimestamp>_<PartNumber></p> <p>where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).</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. To get the status, use the <a>DescribeForecastExportJob</a> operation.</p> </note>"
|
||||
},
|
||||
"CreatePredictor":{
|
||||
"name":"CreatePredictor",
|
||||
|
|
@ -125,7 +125,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceInUseException"}
|
||||
],
|
||||
"documentation":"<p>Deletes an Amazon Forecast dataset that was created using the <a>CreateDataset</a> operation. You can only delete datasets that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status use the <a>DescribeDataset</a> operation.</p>",
|
||||
"documentation":"<p>Deletes an Amazon Forecast dataset that was created using the <a>CreateDataset</a> operation. You can only delete datasets that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status use the <a>DescribeDataset</a> operation.</p> <note> <p>Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.</p> </note>",
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteDatasetGroup":{
|
||||
|
|
@ -397,6 +397,49 @@
|
|||
"documentation":"<p>Returns a list of predictors created using the <a>CreatePredictor</a> operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the <a>DescribePredictor</a> operation. You can filter the list using an array of <a>Filter</a> objects.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceRequest"},
|
||||
"output":{"shape":"ListTagsForResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"documentation":"<p>Lists the tags for an Amazon Forecast resource.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"output":{"shape":"TagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"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 also deleted.</p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"output":{"shape":"UntagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified tags from a resource.</p>"
|
||||
},
|
||||
"UpdateDatasetGroup":{
|
||||
"name":"UpdateDatasetGroup",
|
||||
"http":{
|
||||
|
|
@ -509,6 +552,10 @@
|
|||
"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>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -544,6 +591,10 @@
|
|||
"TimestampFormat":{
|
||||
"shape":"TimestampFormat",
|
||||
"documentation":"<p>The format of timestamps in the dataset. The format that you specify depends on the <code>DataFrequency</code> specified when the dataset was created. The following formats are supported</p> <ul> <li> <p>\"yyyy-MM-dd\"</p> <p>For the following data frequencies: Y, M, W, and D</p> </li> <li> <p>\"yyyy-MM-dd HH:mm:ss\"</p> <p>For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D</p> </li> </ul> <p>If the format isn't specified, Amazon Forecast expects the format to be \"yyyy-MM-dd HH:mm:ss\".</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -588,6 +639,10 @@
|
|||
"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>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -619,6 +674,10 @@
|
|||
"Destination":{
|
||||
"shape":"DataDestination",
|
||||
"documentation":"<p>The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.</p> <p>If encryption is used, <code>Destination</code> must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -648,7 +707,11 @@
|
|||
},
|
||||
"ForecastTypes":{
|
||||
"shape":"ForecastTypes",
|
||||
"documentation":"<p>The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per forecast. Accepted values include <code>0.01 to 0.99</code> (increments of .01 only) and <code>mean</code>. The mean forecast is different from the median (0.50) when the distribution is not symmetric (e.g. Beta, Negative Binomial). The default value is <code>[\"0.1\", \"0.5\", \"0.9\"]</code>.</p>"
|
||||
"documentation":"<p>The quantiles at which probabilistic forecasts are generated. <b>You can currently specify up to 5 quantiles per forecast</b>. Accepted values include <code>0.01 to 0.99</code> (increments of .01 only) and <code>mean</code>. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default value is <code>[\"0.1\", \"0.5\", \"0.9\"]</code>.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -713,6 +776,10 @@
|
|||
"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>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1140,7 +1207,7 @@
|
|||
},
|
||||
"ForecastTypes":{
|
||||
"shape":"ForecastTypes",
|
||||
"documentation":"<p>The quantiles at which proababilistic forecasts were generated.</p>"
|
||||
"documentation":"<p>The quantiles at which probabilistic forecasts were generated.</p>"
|
||||
},
|
||||
"PredictorArn":{
|
||||
"shape":"Arn",
|
||||
|
|
@ -1332,7 +1399,7 @@
|
|||
"members":{
|
||||
"AttributeName":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the schema attribute that specifies the data field to be featurized. 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>"
|
||||
"documentation":"<p>The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the <code>TARGET_TIME_SERIES</code> and the <code>RELATED_TIME_SERIES</code> datasets. 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>. For more information, see <a>howitworks-missing-values</a>.</p>"
|
||||
},
|
||||
"FeaturizationPipeline":{
|
||||
"shape":"FeaturizationPipeline",
|
||||
|
|
@ -1355,10 +1422,10 @@
|
|||
},
|
||||
"Featurizations":{
|
||||
"shape":"Featurizations",
|
||||
"documentation":"<p>An array of featurization (transformation) information for the fields of a dataset. Only a single featurization is supported.</p>"
|
||||
"documentation":"<p>An array of featurization (transformation) information for the fields of a dataset.</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> object 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>"
|
||||
"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> object in your <code>CreatePredictor</code> request. Amazon Forecast applies the featurization to the <code>TARGET_TIME_SERIES</code> and <code>RELATED_TIME_SERIES</code> datasets 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",
|
||||
|
|
@ -1370,10 +1437,10 @@
|
|||
},
|
||||
"FeaturizationMethodParameters":{
|
||||
"shape":"FeaturizationMethodParameters",
|
||||
"documentation":"<p>The method parameters (key-value pairs). Specify these parameters 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>The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.</p> <p>The following list shows the parameters and their valid values for the \"filling\" featurization method for a <b>Target Time Series</b> dataset. 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), <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>, <code>max</code> </p> </li> <li> <p> <code>backfill</code>: <b>zero</b>, <code>nan</code>, <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>, <code>max</code> </p> </li> </ul> <p>The following list shows the parameters and their valid values for a <b>Related Time Series</b> featurization method (there are no defaults):</p> <ul> <li> <p> <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>, <code>max</code> </p> </li> <li> <p> <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>, <code>max</code> </p> </li> <li> <p> <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>, <code>max</code> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides information about the method that featurizes (transforms) a dataset field. The method is part of the <code>FeaturizationPipeline</code> of the <a>Featurization</a> object. If you don't specify <code>FeaturizationMethodParameters</code>, Amazon Forecast uses default parameters.</p> <p>The following is an example of how you specify a <code>FeaturizationMethod</code> object.</p> <p> <code>{</code> </p> <p> <code>\"FeaturizationMethodName\": \"filling\",</code> </p> <p> <code>\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}</code> </p> <p> <code>}</code> </p>"
|
||||
"documentation":"<p>Provides information about the method that featurizes (transforms) a dataset field. The method is part of the <code>FeaturizationPipeline</code> of the <a>Featurization</a> object. </p> <p>The following is an example of how you specify a <code>FeaturizationMethod</code> object.</p> <p> <code>{</code> </p> <p> <code>\"FeaturizationMethodName\": \"filling\",</code> </p> <p> <code>\"FeaturizationMethodParameters\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\": \"zero\"}</code> </p> <p> <code>}</code> </p>"
|
||||
},
|
||||
"FeaturizationMethodName":{
|
||||
"type":"string",
|
||||
|
|
@ -1395,7 +1462,7 @@
|
|||
"Featurizations":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Featurization"},
|
||||
"max":1,
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"FieldStatistics":{
|
||||
|
|
@ -1816,6 +1883,25 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The tags for the resource.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"max":100,
|
||||
|
|
@ -2032,7 +2118,9 @@
|
|||
},
|
||||
"SchemaAttributes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SchemaAttribute"}
|
||||
"member":{"shape":"SchemaAttribute"},
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"Statistics":{
|
||||
"type":"structure",
|
||||
|
|
@ -2094,10 +2182,10 @@
|
|||
},
|
||||
"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>One of the following 2 letter country codes:</p> <ul> <li> <p>\"AR\" - ARGENTINA</p> </li> <li> <p>\"AT\" - AUSTRIA</p> </li> <li> <p>\"AU\" - AUSTRALIA</p> </li> <li> <p>\"BE\" - BELGIUM</p> </li> <li> <p>\"BR\" - BRAZIL</p> </li> <li> <p>\"CA\" - CANADA</p> </li> <li> <p>\"CN\" - CHINA</p> </li> <li> <p>\"CZ\" - CZECH REPUBLIC</p> </li> <li> <p>\"DK\" - DENMARK</p> </li> <li> <p>\"EC\" - ECUADOR</p> </li> <li> <p>\"FI\" - FINLAND</p> </li> <li> <p>\"FR\" - FRANCE</p> </li> <li> <p>\"DE\" - GERMANY</p> </li> <li> <p>\"HU\" - HUNGARY</p> </li> <li> <p>\"IE\" - IRELAND</p> </li> <li> <p>\"IN\" - INDIA</p> </li> <li> <p>\"IT\" - ITALY</p> </li> <li> <p>\"JP\" - JAPAN</p> </li> <li> <p>\"KR\" - KOREA</p> </li> <li> <p>\"LU\" - LUXEMBOURG</p> </li> <li> <p>\"MX\" - MEXICO</p> </li> <li> <p>\"NL\" - NETHERLANDS</p> </li> <li> <p>\"NO\" - NORWAY</p> </li> <li> <p>\"PL\" - POLAND</p> </li> <li> <p>\"PT\" - PORTUGAL</p> </li> <li> <p>\"RU\" - RUSSIA</p> </li> <li> <p>\"ZA\" - SOUTH AFRICA</p> </li> <li> <p>\"ES\" - SPAIN</p> </li> <li> <p>\"SE\" - SWEDEN</p> </li> <li> <p>\"CH\" - SWITZERLAND</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>The only supported feature is a holiday calendar. If you use the calendar, all data in the datasets should belong to the same country as the calendar. For the holiday calendar data, see the <a href=\"http://jollyday.sourceforge.net/data.html\">Jollyday</a> web site.</p>"
|
||||
"documentation":"<p>Describes a supplementary feature of a dataset group. This object is part of the <a>InputDataConfig</a> object.</p> <p>The only supported feature is a holiday calendar. If you use the calendar, all data in the datasets should belong to the same country as the calendar. For the holiday calendar data, see the <a href=\"http://jollyday.sourceforge.net/data.html\">Jollyday</a> web site.</p> <p>India and Korea's holidays are not included in the Jollyday library, but both are supported by Amazon Forecast. Their holidays are:</p> <p> <b>\"IN\" - INDIA</b> </p> <ul> <li> <p> <code>JANUARY 26 - REPUBLIC DAY</code> </p> </li> <li> <p> <code>AUGUST 15 - INDEPENDENCE DAY</code> </p> </li> <li> <p> <code>OCTOBER 2 GANDHI'S BIRTHDAY</code> </p> </li> </ul> <p> <b>\"KR\" - KOREA</b> </p> <ul> <li> <p> <code>JANUARY 1 - NEW YEAR</code> </p> </li> <li> <p> <code>MARCH 1 - INDEPENDENCE MOVEMENT DAY</code> </p> </li> <li> <p> <code>MAY 5 - CHILDREN'S DAY</code> </p> </li> <li> <p> <code>JUNE 6 - MEMORIAL DAY</code> </p> </li> <li> <p> <code>AUGUST 15 - LIBERATION DAY</code> </p> </li> <li> <p> <code>OCTOBER 3 - NATIONAL FOUNDATION DAY</code> </p> </li> <li> <p> <code>OCTOBER 9 - HANGEUL DAY</code> </p> </li> <li> <p> <code>DECEMBER 25 - CHRISTMAS DAY</code> </p> </li> </ul>"
|
||||
},
|
||||
"SupplementaryFeatures":{
|
||||
"type":"list",
|
||||
|
|
@ -2105,6 +2193,70 @@
|
|||
"max":1,
|
||||
"min":1
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Key",
|
||||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label that acts like a category for more specific tag values.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a descriptor within a tag category (key).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"TagKeys":{
|
||||
"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) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The tags to add to the resource. A tag is an array of key-value pairs.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50.</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8.</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8.</p> </li> <li> <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"Tags":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"},
|
||||
"max":200,
|
||||
"min":0
|
||||
},
|
||||
"TestWindowDetails":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TestWindowSummary"}
|
||||
|
|
@ -2148,6 +2300,28 @@
|
|||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceArn",
|
||||
"TagKeys"
|
||||
],
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast exports.</p>"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"TagKeys",
|
||||
"documentation":"<p>The keys of the tags to be removed.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UntagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateDatasetGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@
|
|||
{"shape":"ServiceLimitExceeded"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.</p> <p>If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns <code>IncompatibleParameterError</code>. If a backup with the specified client request token doesn't exist, <code>CreateBackup</code> does the following: </p> <ul> <li> <p>Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the backup.</p> </li> </ul> <p>By using the idempotent operation, you can retry a <code>CreateBackup</code> operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.</p> <p>The <code>CreateFileSystem</code> operation returns while the backup's lifecycle state is still <code>CREATING</code>. You can check the file system creation status by calling the <a>DescribeBackups</a> operation, which returns the backup state along with other information.</p> <note> <p/> </note>",
|
||||
"documentation":"<p>Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.</p> <p>For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:</p> <ul> <li> <p>a Persistent deployment type</p> </li> <li> <p>is <i>not</i> linked to an Amazon S3 data respository.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-backups.html\">https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-backups.html</a>.</p> <p>If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns <code>IncompatibleParameterError</code>. If a backup with the specified client request token doesn't exist, <code>CreateBackup</code> does the following: </p> <ul> <li> <p>Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the backup.</p> </li> </ul> <p>By using the idempotent operation, you can retry a <code>CreateBackup</code> operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.</p> <p>The <code>CreateBackup</code> operation returns while the backup's lifecycle state is still <code>CREATING</code>. You can check the backup creation status by calling the <a>DescribeBackups</a> operation, which returns the backup state along with other information.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"CreateDataRepositoryTask":{
|
||||
|
|
@ -106,12 +106,13 @@
|
|||
{"shape":"ActiveDirectoryError"},
|
||||
{"shape":"IncompatibleParameterError"},
|
||||
{"shape":"InvalidNetworkSettings"},
|
||||
{"shape":"InvalidPerUnitStorageThroughput"},
|
||||
{"shape":"ServiceLimitExceeded"},
|
||||
{"shape":"BackupNotFound"},
|
||||
{"shape":"InternalServerError"},
|
||||
{"shape":"MissingFileSystemConfiguration"}
|
||||
],
|
||||
"documentation":"<p>Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.</p> <p>If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file system with the specified client request token doesn't exist, this operation does the following:</p> <ul> <li> <p>Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the file system.</p> </li> </ul> <p>Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.</p> <p>By using the idempotent operation, you can retry a <code>CreateFileSystemFromBackup</code> call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.</p> <note> <p>The <code>CreateFileSystemFromBackup</code> call returns while the file system's lifecycle state is still <code>CREATING</code>. You can check the file-system creation status by calling the <a>DescribeFileSystems</a> operation, which returns the file system state along with other information.</p> </note>"
|
||||
"documentation":"<p>Creates a new Amazon FSx file system from an existing Amazon FSx backup.</p> <p>If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns <code>IncompatibleParameterError</code>. If a file system with the specified client request token doesn't exist, this operation does the following:</p> <ul> <li> <p>Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of <code>CREATING</code>.</p> </li> <li> <p>Returns the description of the file system.</p> </li> </ul> <p>Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.</p> <p>By using the idempotent operation, you can retry a <code>CreateFileSystemFromBackup</code> call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.</p> <note> <p>The <code>CreateFileSystemFromBackup</code> call returns while the file system's lifecycle state is still <code>CREATING</code>. You can check the file-system creation status by calling the <a>DescribeFileSystems</a> operation, which returns the file system state along with other information.</p> </note>"
|
||||
},
|
||||
"DeleteBackup":{
|
||||
"name":"DeleteBackup",
|
||||
|
|
@ -129,7 +130,7 @@
|
|||
{"shape":"IncompatibleParameterError"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.</p> <p>The <code>DeleteBackup</code> call returns instantly. The backup will not show up in later <code>DescribeBackups</code> calls.</p> <important> <p>The data in a deleted backup is also deleted and can't be recovered by any means.</p> </important>",
|
||||
"documentation":"<p>Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.</p> <p>The <code>DeleteBackup</code> call returns instantly. The backup will not show up in later <code>DescribeBackups</code> calls.</p> <important> <p>The data in a deleted backup is also deleted and can't be recovered by any means.</p> </important>",
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteFileSystem":{
|
||||
|
|
@ -164,7 +165,7 @@
|
|||
{"shape":"BackupNotFound"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Returns the description of specific Amazon FSx for Windows File Server backups, if a <code>BackupIds</code> value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.</p> <p>When retrieving all backups, you can optionally specify the <code>MaxResults</code> parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response.</p> <p>This action is used in an iterative process to retrieve a list of your backups. <code>DescribeBackups</code> is called first without a <code>NextToken</code>value. Then the action continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code>.</p> <p>When using this action, keep the following in mind:</p> <ul> <li> <p>The implementation might return fewer than <code>MaxResults</code> file system descriptions while still including a <code>NextToken</code> value.</p> </li> <li> <p>The order of backups returned in the response of one <code>DescribeBackups</code> call and the order of backups returned across the responses of a multi-call iteration is unspecified.</p> </li> </ul>"
|
||||
"documentation":"<p>Returns the description of specific Amazon FSx backups, if a <code>BackupIds</code> value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.</p> <p>When retrieving all backups, you can optionally specify the <code>MaxResults</code> parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a <code>NextToken</code> value in the response. In this case, send a later request with the <code>NextToken</code> request parameter set to the value of <code>NextToken</code> from the last response.</p> <p>This action is used in an iterative process to retrieve a list of your backups. <code>DescribeBackups</code> is called first without a <code>NextToken</code>value. Then the action continues to be called with the <code>NextToken</code> parameter set to the value of the last <code>NextToken</code> value until a response has no <code>NextToken</code>.</p> <p>When using this action, keep the following in mind:</p> <ul> <li> <p>The implementation might return fewer than <code>MaxResults</code> file system descriptions while still including a <code>NextToken</code> value.</p> </li> <li> <p>The order of backups returned in the response of one <code>DescribeBackups</code> call and the order of backups returned across the responses of a multi-call iteration is unspecified.</p> </li> </ul>"
|
||||
},
|
||||
"DescribeDataRepositoryTasks":{
|
||||
"name":"DescribeDataRepositoryTasks",
|
||||
|
|
@ -323,7 +324,7 @@
|
|||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"^.{1,255}$"
|
||||
"pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$"
|
||||
},
|
||||
"AdministrativeAction":{
|
||||
"type":"structure",
|
||||
|
|
@ -376,11 +377,11 @@
|
|||
"type":"string",
|
||||
"max":900,
|
||||
"min":3,
|
||||
"pattern":"^.{3,900}$"
|
||||
"pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$"
|
||||
},
|
||||
"AutomaticBackupRetentionDays":{
|
||||
"type":"integer",
|
||||
"documentation":"<p>The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.</p>",
|
||||
"documentation":"<p>The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days. The default is 0.</p>",
|
||||
"max":35,
|
||||
"min":0
|
||||
},
|
||||
|
|
@ -436,7 +437,7 @@
|
|||
"documentation":"<p>The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A backup of an Amazon FSx for Windows File Server file system. You can create a new file system from a backup to protect against data loss.</p>"
|
||||
"documentation":"<p>A backup of an Amazon FSx for file system.</p>"
|
||||
},
|
||||
"BackupFailureDetails":{
|
||||
"type":"structure",
|
||||
|
|
@ -585,12 +586,12 @@
|
|||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.</p>",
|
||||
"documentation":"<p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The tags to apply to the backup at backup creation. The key value of the <code>Name</code> tag appears in the console as the backup name.</p>"
|
||||
"documentation":"<p>The tags to apply to the backup at backup creation. The key value of the <code>Name</code> tag appears in the console as the backup name. If you have set <code>CopyTagsToBackups</code> to true, and you specify one or more tags using the <code>CreateBackup</code> action, no existing tags on the file system are copied from the file system to the backup.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request object for the <code>CreateBackup</code> operation.</p>"
|
||||
|
|
@ -652,7 +653,7 @@
|
|||
"BackupId":{"shape":"BackupId"},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.</p>",
|
||||
"documentation":"<p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"SubnetIds":{
|
||||
|
|
@ -671,6 +672,7 @@
|
|||
"shape":"CreateFileSystemWindowsConfiguration",
|
||||
"documentation":"<p>The configuration for this Microsoft Windows file system.</p>"
|
||||
},
|
||||
"LustreConfiguration":{"shape":"CreateFileSystemLustreConfiguration"},
|
||||
"StorageType":{
|
||||
"shape":"StorageType",
|
||||
"documentation":"<p>Sets the storage type for the Windows file system you're creating from a backup. Valid values are <code>SSD</code> and <code>HDD</code>.</p> <ul> <li> <p>Set to <code>SSD</code> to use solid state drive storage. Supported on all Windows deployment types.</p> </li> <li> <p>Set to <code>HDD</code> to use hard disk drive storage. Supported on <code>SINGLE_AZ_2</code> and <code>MULTI_AZ_1</code> Windows file system deployment types. </p> </li> </ul> <p> Default value is <code>SSD</code>. </p> <note> <p>HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB. </p> </note>"
|
||||
|
|
@ -709,11 +711,17 @@
|
|||
},
|
||||
"DeploymentType":{
|
||||
"shape":"LustreDeploymentType",
|
||||
"documentation":"<p>(Optional) Choose <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment types when you need temporary storage and shorter-term processing of data. The <code>SCRATCH_2</code> deployment type provides in-transit encryption of data and higher burst throughput capacity than <code>SCRATCH_1</code>.</p> <p>Choose <code>PERSISTENT_1</code> deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html\"> FSx for Lustre Deployment Options</a>.</p> <p>Encryption of data in-transit is automatically enabled when you access a <code>SCRATCH_2</code> or <code>PERSISTENT_1</code> file system from Amazon EC2 instances that <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html\">support this feature</a>. (Default = <code>SCRATCH_1</code>) </p> <p>Encryption of data in-transit for <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html\">Encrypting Data in Transit</a>.</p>"
|
||||
"documentation":"<p> Choose <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment types when you need temporary storage and shorter-term processing of data. The <code>SCRATCH_2</code> deployment type provides in-transit encryption of data and higher burst throughput capacity than <code>SCRATCH_1</code>.</p> <note> <p>This option can only be set for for PERSISTENT_1 deployments types.</p> </note> <p>Choose <code>PERSISTENT_1</code> deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html\"> FSx for Lustre Deployment Options</a>.</p> <p>Encryption of data in-transit is automatically enabled when you access a <code>SCRATCH_2</code> or <code>PERSISTENT_1</code> file system from Amazon EC2 instances that <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html\">support this feature</a>. (Default = <code>SCRATCH_1</code>) </p> <p>Encryption of data in-transit for <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/encryption-in-transit-fsxl.html\">Encrypting Data in Transit</a>.</p>"
|
||||
},
|
||||
"PerUnitStorageThroughput":{
|
||||
"shape":"PerUnitStorageThroughput",
|
||||
"documentation":"<p> Required for the <code>PERSISTENT_1</code> deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 117 MB/s of file system throughput. You pay for the amount of throughput that you provision. </p> <p>Valid values are 50, 100, 200.</p>"
|
||||
},
|
||||
"DailyAutomaticBackupStartTime":{"shape":"DailyTime"},
|
||||
"AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"},
|
||||
"CopyTagsToBackups":{
|
||||
"shape":"Flag",
|
||||
"documentation":"<p>A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Lustre configuration for the file system being created. </p>"
|
||||
|
|
@ -728,7 +736,7 @@
|
|||
"members":{
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.</p>",
|
||||
"documentation":"<p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"FileSystemType":{
|
||||
|
|
@ -983,7 +991,7 @@
|
|||
"type":"string",
|
||||
"max":4096,
|
||||
"min":0,
|
||||
"pattern":"^.{0,4096}$"
|
||||
"pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{0,4096}$"
|
||||
},
|
||||
"DataRepositoryTaskPaths":{
|
||||
"type":"list",
|
||||
|
|
@ -1031,7 +1039,7 @@
|
|||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.</p>",
|
||||
"documentation":"<p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.</p>",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
},
|
||||
|
|
@ -1051,6 +1059,34 @@
|
|||
},
|
||||
"documentation":"<p>The response object for <code>DeleteBackup</code> operation.</p>"
|
||||
},
|
||||
"DeleteFileSystemLustreConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SkipFinalBackup":{
|
||||
"shape":"Flag",
|
||||
"documentation":"<p>Set <code>SkipFinalBackup</code> to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the <code>DeleteFileSystem</code> operation is invoked. (Default = true)</p>"
|
||||
},
|
||||
"FinalBackupTags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>Use if <code>SkipFinalBackup</code> is set to <code>false</code>, and you want to apply an array of tags to the final backup. If you have set the file system property <code>CopyTagsToBackups</code> to true, and you specify one or more <code>FinalBackupTags</code> when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration object for the Amazon FSx for Lustre file system being deleted in the <code>DeleteFileSystem</code> operation.</p>"
|
||||
},
|
||||
"DeleteFileSystemLustreResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"FinalBackupId":{
|
||||
"shape":"BackupId",
|
||||
"documentation":"<p>The ID of the final backup for this file system.</p>"
|
||||
},
|
||||
"FinalBackupTags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>The set of tags applied to the final backup.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The response object for the Amazon FSx for Lustre file system being deleted in the <code>DeleteFileSystem</code> operation.</p>"
|
||||
},
|
||||
"DeleteFileSystemRequest":{
|
||||
"type":"structure",
|
||||
"required":["FileSystemId"],
|
||||
|
|
@ -1061,10 +1097,11 @@
|
|||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.</p>",
|
||||
"documentation":"<p>A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"WindowsConfiguration":{"shape":"DeleteFileSystemWindowsConfiguration"}
|
||||
"WindowsConfiguration":{"shape":"DeleteFileSystemWindowsConfiguration"},
|
||||
"LustreConfiguration":{"shape":"DeleteFileSystemLustreConfiguration"}
|
||||
},
|
||||
"documentation":"<p>The request object for <code>DeleteFileSystem</code> operation.</p>"
|
||||
},
|
||||
|
|
@ -1079,7 +1116,8 @@
|
|||
"shape":"FileSystemLifecycle",
|
||||
"documentation":"<p>The file system lifecycle for the deletion request. Should be <code>DELETING</code>.</p>"
|
||||
},
|
||||
"WindowsResponse":{"shape":"DeleteFileSystemWindowsResponse"}
|
||||
"WindowsResponse":{"shape":"DeleteFileSystemWindowsResponse"},
|
||||
"LustreResponse":{"shape":"DeleteFileSystemLustreResponse"}
|
||||
},
|
||||
"documentation":"<p>The response object for the <code>DeleteFileSystem</code> operation.</p>"
|
||||
},
|
||||
|
|
@ -1116,19 +1154,19 @@
|
|||
"members":{
|
||||
"BackupIds":{
|
||||
"shape":"BackupIds",
|
||||
"documentation":"<p>(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.</p>"
|
||||
"documentation":"<p>IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"Filters",
|
||||
"documentation":"<p>(Optional) Filters structure. Supported names are file-system-id and backup-type.</p>"
|
||||
"documentation":"<p>Filters structure. Supported names are file-system-id and backup-type.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>(Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"
|
||||
"documentation":"<p>Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>(Optional) Opaque pagination token returned from a previous <code>DescribeBackups</code> operation (String). If a token present, the action continues the list from where the returning call left off.</p>"
|
||||
"documentation":"<p>Opaque pagination token returned from a previous <code>DescribeBackups</code> operation (String). If a token present, the action continues the list from where the returning call left off.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request object for <code>DescribeBackups</code> operation.</p>"
|
||||
|
|
@ -1177,15 +1215,15 @@
|
|||
"members":{
|
||||
"FileSystemIds":{
|
||||
"shape":"FileSystemIds",
|
||||
"documentation":"<p>(Optional) IDs of the file systems whose descriptions you want to retrieve (String).</p>"
|
||||
"documentation":"<p>IDs of the file systems whose descriptions you want to retrieve (String).</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>(Optional) Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"
|
||||
"documentation":"<p>Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>(Optional) Opaque pagination token returned from a previous <code>DescribeFileSystems</code> operation (String). If a token present, the action continues the list from where the returning call left off.</p>"
|
||||
"documentation":"<p>Opaque pagination token returned from a previous <code>DescribeFileSystems</code> operation (String). If a token present, the action continues the list from where the returning call left off.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request object for <code>DescribeFileSystems</code> operation.</p>"
|
||||
|
|
@ -1221,7 +1259,7 @@
|
|||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"^.{1,256}$"
|
||||
"pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$"
|
||||
},
|
||||
"DnsIps":{
|
||||
"type":"list",
|
||||
|
|
@ -1313,7 +1351,7 @@
|
|||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"^.{1,256}$"
|
||||
"pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$"
|
||||
},
|
||||
"FileSystemFailureDetails":{
|
||||
"type":"structure",
|
||||
|
|
@ -1405,7 +1443,8 @@
|
|||
"documentation":"<p>The name for a filter.</p>",
|
||||
"enum":[
|
||||
"file-system-id",
|
||||
"backup-type"
|
||||
"backup-type",
|
||||
"file-system-type"
|
||||
]
|
||||
},
|
||||
"FilterValue":{
|
||||
|
|
@ -1508,11 +1547,11 @@
|
|||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>(Optional) Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"
|
||||
"documentation":"<p>Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the <code>MaxResults</code> parameter specified in the request and the service's internal maximum number of items per page.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>(Optional) Opaque pagination token returned from a previous <code>ListTagsForResource</code> operation (String). If a token present, the action continues the list from where the returning call left off.</p>"
|
||||
"documentation":"<p>Opaque pagination token returned from a previous <code>ListTagsForResource</code> operation (String). If a token present, the action continues the list from where the returning call left off.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request object for <code>ListTagsForResource</code> operation.</p>"
|
||||
|
|
@ -1549,7 +1588,7 @@
|
|||
"DataRepositoryConfiguration":{"shape":"DataRepositoryConfiguration"},
|
||||
"DeploymentType":{
|
||||
"shape":"LustreDeploymentType",
|
||||
"documentation":"<p>The deployment type of the FSX for Lustre file system.</p>"
|
||||
"documentation":"<p>The deployment type of the FSX for Lustre file system. <i>Scratch deployment type</i> is designed for temporary storage and shorter-term processing of data.</p> <p> <code>SCRATCH_1</code> and <code>SCRATCH_2</code> deployment types are best suited for when you need temporary storage and shorter-term processing of data. The <code>SCRATCH_2</code> deployment type provides in-transit encryption of data and higher burst throughput capacity than <code>SCRATCH_1</code>.</p> <p>The <code>PERSISTENT_1</code> deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see <a href=\"https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html\"> FSx for Lustre Deployment Options</a>. (Default = <code>SCRATCH_1</code>)</p>"
|
||||
},
|
||||
"PerUnitStorageThroughput":{
|
||||
"shape":"PerUnitStorageThroughput",
|
||||
|
|
@ -1558,6 +1597,12 @@
|
|||
"MountName":{
|
||||
"shape":"LustreFileSystemMountName",
|
||||
"documentation":"<p>You use the <code>MountName</code> value when mounting the file system.</p> <p>For the <code>SCRATCH_1</code> deployment type, this value is always \"<code>fsx</code>\". For <code>SCRATCH_2</code> and <code>PERSISTENT_1</code> deployment types, this value is a string that is unique within an AWS Region. </p>"
|
||||
},
|
||||
"DailyAutomaticBackupStartTime":{"shape":"DailyTime"},
|
||||
"AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"},
|
||||
"CopyTagsToBackups":{
|
||||
"shape":"Flag",
|
||||
"documentation":"<p>A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration for the Amazon FSx for Lustre file system.</p>"
|
||||
|
|
@ -1630,7 +1675,7 @@
|
|||
"type":"string",
|
||||
"max":2000,
|
||||
"min":1,
|
||||
"pattern":"^.{1,2000}$"
|
||||
"pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$"
|
||||
},
|
||||
"Parameter":{
|
||||
"type":"string",
|
||||
|
|
@ -1961,7 +2006,9 @@
|
|||
"WeeklyMaintenanceStartTime":{
|
||||
"shape":"WeeklyTime",
|
||||
"documentation":"<p>The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.</p>"
|
||||
}
|
||||
},
|
||||
"DailyAutomaticBackupStartTime":{"shape":"DailyTime"},
|
||||
"AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"}
|
||||
},
|
||||
"documentation":"<p>The configuration object for Amazon FSx for Lustre file systems used in the <code>UpdateFileSystem</code> operation.</p>"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -481,6 +481,40 @@
|
|||
],
|
||||
"documentation":"<p>Removes a classifier from the Data Catalog.</p>"
|
||||
},
|
||||
"DeleteColumnStatisticsForPartition":{
|
||||
"name":"DeleteColumnStatisticsForPartition",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteColumnStatisticsForPartitionRequest"},
|
||||
"output":{"shape":"DeleteColumnStatisticsForPartitionResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Delete the partition column statistics of a column.</p>"
|
||||
},
|
||||
"DeleteColumnStatisticsForTable":{
|
||||
"name":"DeleteColumnStatisticsForTable",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteColumnStatisticsForTableRequest"},
|
||||
"output":{"shape":"DeleteColumnStatisticsForTableResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves table statistics of columns.</p>"
|
||||
},
|
||||
"DeleteConnection":{
|
||||
"name":"DeleteConnection",
|
||||
"http":{
|
||||
|
|
@ -744,6 +778,40 @@
|
|||
],
|
||||
"documentation":"<p>Lists all classifier objects in the Data Catalog.</p>"
|
||||
},
|
||||
"GetColumnStatisticsForPartition":{
|
||||
"name":"GetColumnStatisticsForPartition",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetColumnStatisticsForPartitionRequest"},
|
||||
"output":{"shape":"GetColumnStatisticsForPartitionResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves partition statistics of columns.</p>"
|
||||
},
|
||||
"GetColumnStatisticsForTable":{
|
||||
"name":"GetColumnStatisticsForTable",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetColumnStatisticsForTableRequest"},
|
||||
"output":{"shape":"GetColumnStatisticsForTableResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves table statistics of columns.</p>"
|
||||
},
|
||||
"GetConnection":{
|
||||
"name":"GetConnection",
|
||||
"http":{
|
||||
|
|
@ -1121,6 +1189,22 @@
|
|||
],
|
||||
"documentation":"<p>Gets code to perform a specified mapping.</p>"
|
||||
},
|
||||
"GetResourcePolicies":{
|
||||
"name":"GetResourcePolicies",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetResourcePoliciesRequest"},
|
||||
"output":{"shape":"GetResourcePoliciesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the security configurations for the resource policies set on individual resources, and also the account-level policy.</p>"
|
||||
},
|
||||
"GetResourcePolicy":{
|
||||
"name":"GetResourcePolicy",
|
||||
"http":{
|
||||
|
|
@ -1839,6 +1923,40 @@
|
|||
],
|
||||
"documentation":"<p>Modifies an existing classifier (a <code>GrokClassifier</code>, an <code>XMLClassifier</code>, a <code>JsonClassifier</code>, or a <code>CsvClassifier</code>, depending on which field is present).</p>"
|
||||
},
|
||||
"UpdateColumnStatisticsForPartition":{
|
||||
"name":"UpdateColumnStatisticsForPartition",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateColumnStatisticsForPartitionRequest"},
|
||||
"output":{"shape":"UpdateColumnStatisticsForPartitionResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates partition statistics of columns.</p>"
|
||||
},
|
||||
"UpdateColumnStatisticsForTable":{
|
||||
"name":"UpdateColumnStatisticsForTable",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateColumnStatisticsForTableRequest"},
|
||||
"output":{"shape":"UpdateColumnStatisticsForTableResponse"},
|
||||
"errors":[
|
||||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"GlueEncryptionException"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates table statistics of columns.</p>"
|
||||
},
|
||||
"UpdateConnection":{
|
||||
"name":"UpdateConnection",
|
||||
"http":{
|
||||
|
|
@ -2524,7 +2642,54 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"BatchStopJobRunSuccessfulSubmission"}
|
||||
},
|
||||
"BinaryColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"MaximumLength",
|
||||
"AverageLength",
|
||||
"NumberOfNulls"
|
||||
],
|
||||
"members":{
|
||||
"MaximumLength":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Maximum length of the column.</p>"
|
||||
},
|
||||
"AverageLength":{
|
||||
"shape":"NonNegativeDouble",
|
||||
"documentation":"<p>Average length of the column.</p>"
|
||||
},
|
||||
"NumberOfNulls":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of nulls.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a binary column statistics data.</p>"
|
||||
},
|
||||
"Blob":{"type":"blob"},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"BooleanColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"NumberOfTrues",
|
||||
"NumberOfFalses",
|
||||
"NumberOfNulls"
|
||||
],
|
||||
"members":{
|
||||
"NumberOfTrues":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of true value.</p>"
|
||||
},
|
||||
"NumberOfFalses":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of false value.</p>"
|
||||
},
|
||||
"NumberOfNulls":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of nulls.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a boolean column statistics.</p>"
|
||||
},
|
||||
"BooleanNullable":{"type":"boolean"},
|
||||
"BooleanValue":{"type":"boolean"},
|
||||
"BoundedPartitionValueList":{
|
||||
|
|
@ -2808,6 +2973,24 @@
|
|||
},
|
||||
"documentation":"<p>A column in a <code>Table</code>.</p>"
|
||||
},
|
||||
"ColumnError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ColumnName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the column.</p>"
|
||||
},
|
||||
"Error":{
|
||||
"shape":"ErrorDetail",
|
||||
"documentation":"<p>The error message occurred during operation.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a column containing error.</p>"
|
||||
},
|
||||
"ColumnErrors":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ColumnError"}
|
||||
},
|
||||
"ColumnList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Column"}
|
||||
|
|
@ -2818,6 +3001,107 @@
|
|||
"min":1,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"ColumnStatistics":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ColumnName",
|
||||
"ColumnType",
|
||||
"AnalyzedTime",
|
||||
"StatisticsData"
|
||||
],
|
||||
"members":{
|
||||
"ColumnName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the column.</p>"
|
||||
},
|
||||
"ColumnType":{
|
||||
"shape":"TypeString",
|
||||
"documentation":"<p>The type of the column.</p>"
|
||||
},
|
||||
"AnalyzedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The analyzed time of the column statistics.</p>"
|
||||
},
|
||||
"StatisticsData":{
|
||||
"shape":"ColumnStatisticsData",
|
||||
"documentation":"<p>The statistics of the column.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a column statistics.</p>"
|
||||
},
|
||||
"ColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":["Type"],
|
||||
"members":{
|
||||
"Type":{
|
||||
"shape":"ColumnStatisticsType",
|
||||
"documentation":"<p>The name of the column.</p>"
|
||||
},
|
||||
"BooleanColumnStatisticsData":{
|
||||
"shape":"BooleanColumnStatisticsData",
|
||||
"documentation":"<p>Boolean Column Statistics Data.</p>"
|
||||
},
|
||||
"DateColumnStatisticsData":{
|
||||
"shape":"DateColumnStatisticsData",
|
||||
"documentation":"<p>Date Column Statistics Data.</p>"
|
||||
},
|
||||
"DecimalColumnStatisticsData":{
|
||||
"shape":"DecimalColumnStatisticsData",
|
||||
"documentation":"<p>Decimal Column Statistics Data.</p>"
|
||||
},
|
||||
"DoubleColumnStatisticsData":{
|
||||
"shape":"DoubleColumnStatisticsData",
|
||||
"documentation":"<p>Double Column Statistics Data.</p>"
|
||||
},
|
||||
"LongColumnStatisticsData":{
|
||||
"shape":"LongColumnStatisticsData",
|
||||
"documentation":"<p>Long Column Statistics Data.</p>"
|
||||
},
|
||||
"StringColumnStatisticsData":{
|
||||
"shape":"StringColumnStatisticsData",
|
||||
"documentation":"<p>String Column Statistics Data.</p>"
|
||||
},
|
||||
"BinaryColumnStatisticsData":{
|
||||
"shape":"BinaryColumnStatisticsData",
|
||||
"documentation":"<p>Binary Column Statistics Data.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a column statistics data.</p>"
|
||||
},
|
||||
"ColumnStatisticsError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ColumnStatistics":{
|
||||
"shape":"ColumnStatistics",
|
||||
"documentation":"<p>The ColumnStatistics of the column.</p>"
|
||||
},
|
||||
"Error":{
|
||||
"shape":"ErrorDetail",
|
||||
"documentation":"<p>The error message occurred during operation.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a column containing error.</p>"
|
||||
},
|
||||
"ColumnStatisticsErrors":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ColumnStatisticsError"}
|
||||
},
|
||||
"ColumnStatisticsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ColumnStatistics"}
|
||||
},
|
||||
"ColumnStatisticsType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"BOOLEAN",
|
||||
"DATE",
|
||||
"DECIMAL",
|
||||
"DOUBLE",
|
||||
"LONG",
|
||||
"STRING",
|
||||
"BINARY"
|
||||
]
|
||||
},
|
||||
"ColumnTypeString":{
|
||||
"type":"string",
|
||||
"max":131072,
|
||||
|
|
@ -2943,7 +3227,7 @@
|
|||
},
|
||||
"ConnectionType":{
|
||||
"shape":"ConnectionType",
|
||||
"documentation":"<p>The type of the connection. Currently, only JDBC is supported; SFTP is not supported.</p>"
|
||||
"documentation":"<p>The type of the connection. Currently, SFTP is not supported.</p>"
|
||||
},
|
||||
"MatchCriteria":{
|
||||
"shape":"MatchCriteria",
|
||||
|
|
@ -4240,10 +4524,32 @@
|
|||
"CreateTableDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>Creates a set of default permissions on the table for principals. </p>"
|
||||
},
|
||||
"TargetDatabase":{
|
||||
"shape":"DatabaseIdentifier",
|
||||
"documentation":"<p>A <code>DatabaseIdentifier</code> structure that describes a target database for resource linking.</p>"
|
||||
},
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the database resides.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The <code>Database</code> object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.</p>"
|
||||
},
|
||||
"DatabaseIdentifier":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the database resides.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure that describes a target database for resource linking.</p>"
|
||||
},
|
||||
"DatabaseInput":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
|
|
@ -4267,6 +4573,10 @@
|
|||
"CreateTableDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>Creates a set of default permissions on the table for principals. </p>"
|
||||
},
|
||||
"TargetDatabase":{
|
||||
"shape":"DatabaseIdentifier",
|
||||
"documentation":"<p>A <code>DatabaseIdentifier</code> structure that describes a target database for resource linking.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The structure used to create or update a database.</p>"
|
||||
|
|
@ -4276,6 +4586,76 @@
|
|||
"member":{"shape":"Database"}
|
||||
},
|
||||
"DatabaseName":{"type":"string"},
|
||||
"DateColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"NumberOfNulls",
|
||||
"NumberOfDistinctValues"
|
||||
],
|
||||
"members":{
|
||||
"MinimumValue":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Minimum value of the column.</p>"
|
||||
},
|
||||
"MaximumValue":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>Maximum value of the column.</p>"
|
||||
},
|
||||
"NumberOfNulls":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of nulls.</p>"
|
||||
},
|
||||
"NumberOfDistinctValues":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of distinct values.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a date column statistics data.</p>"
|
||||
},
|
||||
"DecimalColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"NumberOfNulls",
|
||||
"NumberOfDistinctValues"
|
||||
],
|
||||
"members":{
|
||||
"MinimumValue":{
|
||||
"shape":"DecimalNumber",
|
||||
"documentation":"<p>Minimum value of the column.</p>"
|
||||
},
|
||||
"MaximumValue":{
|
||||
"shape":"DecimalNumber",
|
||||
"documentation":"<p>Maximum value of the column.</p>"
|
||||
},
|
||||
"NumberOfNulls":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of nulls.</p>"
|
||||
},
|
||||
"NumberOfDistinctValues":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of distinct values.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a decimal column statistics data.</p>"
|
||||
},
|
||||
"DecimalNumber":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"UnscaledValue",
|
||||
"Scale"
|
||||
],
|
||||
"members":{
|
||||
"UnscaledValue":{
|
||||
"shape":"Blob",
|
||||
"documentation":"<p>The unscaled numeric value.</p>"
|
||||
},
|
||||
"Scale":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The scale that determines where the decimal point falls in the unscaled value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains a numeric value in decimal format.</p>"
|
||||
},
|
||||
"DeleteBehavior":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -4299,6 +4679,73 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteColumnStatisticsForPartitionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"TableName",
|
||||
"PartitionValues",
|
||||
"ColumnName"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the partitions reside.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the partitions' table.</p>"
|
||||
},
|
||||
"PartitionValues":{
|
||||
"shape":"ValueStringList",
|
||||
"documentation":"<p>A list of partition values identifying the partition.</p>"
|
||||
},
|
||||
"ColumnName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>Name of the column.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteColumnStatisticsForPartitionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteColumnStatisticsForTableRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"TableName",
|
||||
"ColumnName"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the partitions reside.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the partitions' table.</p>"
|
||||
},
|
||||
"ColumnName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the column.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteColumnStatisticsForTableResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteConnectionNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NameString"},
|
||||
|
|
@ -4448,6 +4895,10 @@
|
|||
"PolicyHashCondition":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The hash value returned when this policy was set.</p>"
|
||||
},
|
||||
"ResourceArn":{
|
||||
"shape":"GlueResourceArn",
|
||||
"documentation":"<p>The ARN of the AWS Glue resource for the resource policy to be deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4738,6 +5189,33 @@
|
|||
"max":25,
|
||||
"min":1
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"DoubleColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"NumberOfNulls",
|
||||
"NumberOfDistinctValues"
|
||||
],
|
||||
"members":{
|
||||
"MinimumValue":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>Minimum value of the column.</p>"
|
||||
},
|
||||
"MaximumValue":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>Maximum value of the column.</p>"
|
||||
},
|
||||
"NumberOfNulls":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of nulls.</p>"
|
||||
},
|
||||
"NumberOfDistinctValues":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of distinct values.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a double column statistics data.</p>"
|
||||
},
|
||||
"DynamoDBTarget":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -4778,6 +5256,13 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Edge"}
|
||||
},
|
||||
"EnableHybridValues":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"TRUE",
|
||||
"FALSE"
|
||||
]
|
||||
},
|
||||
"EncryptionAtRest":{
|
||||
"type":"structure",
|
||||
"required":["CatalogEncryptionMode"],
|
||||
|
|
@ -5039,6 +5524,95 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetColumnNamesList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NameString"},
|
||||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"GetColumnStatisticsForPartitionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"TableName",
|
||||
"PartitionValues",
|
||||
"ColumnNames"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the partitions reside.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the partitions' table.</p>"
|
||||
},
|
||||
"PartitionValues":{
|
||||
"shape":"ValueStringList",
|
||||
"documentation":"<p>A list of partition values identifying the partition.</p>"
|
||||
},
|
||||
"ColumnNames":{
|
||||
"shape":"GetColumnNamesList",
|
||||
"documentation":"<p>A list of the column names.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetColumnStatisticsForPartitionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ColumnStatisticsList":{
|
||||
"shape":"ColumnStatisticsList",
|
||||
"documentation":"<p>List of ColumnStatistics that failed to be retrieved.</p>"
|
||||
},
|
||||
"Errors":{
|
||||
"shape":"ColumnErrors",
|
||||
"documentation":"<p>Error occurred during retrieving column statistics data.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetColumnStatisticsForTableRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"TableName",
|
||||
"ColumnNames"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the partitions reside.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the partitions' table.</p>"
|
||||
},
|
||||
"ColumnNames":{
|
||||
"shape":"GetColumnNamesList",
|
||||
"documentation":"<p>A list of the column names.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetColumnStatisticsForTableResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ColumnStatisticsList":{
|
||||
"shape":"ColumnStatisticsList",
|
||||
"documentation":"<p>List of ColumnStatistics that failed to be retrieved.</p>"
|
||||
},
|
||||
"Errors":{
|
||||
"shape":"ColumnErrors",
|
||||
"documentation":"<p>List of ColumnStatistics that failed to be retrieved.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetConnectionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
|
|
@ -5075,7 +5649,7 @@
|
|||
},
|
||||
"ConnectionType":{
|
||||
"shape":"ConnectionType",
|
||||
"documentation":"<p>The type of connections to return. Currently, only JDBC is supported; SFTP is not supported.</p>"
|
||||
"documentation":"<p>The type of connections to return. Currently, SFTP is not supported.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Filters the connection definitions that are returned by the <code>GetConnections</code> API operation.</p>"
|
||||
|
|
@ -5248,6 +5822,10 @@
|
|||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of databases to return in one response.</p>"
|
||||
},
|
||||
"ResourceShareType":{
|
||||
"shape":"ResourceShareType",
|
||||
"documentation":"<p>Allows you to specify that you want to list the databases shared with your account. The allowable values are <code>FOREIGN</code> or <code>ALL</code>. </p> <ul> <li> <p>If set to <code>FOREIGN</code>, will list the databases shared with your account. </p> </li> <li> <p>If set to <code>ALL</code>, will list the databases shared with your account, as well as the databases in yor local account. </p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -5839,9 +6417,43 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetResourcePoliciesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if this is a continuation request.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum size of a list to return.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetResourcePoliciesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GetResourcePoliciesResponseList":{
|
||||
"shape":"GetResourcePoliciesResponseList",
|
||||
"documentation":"<p>A list of the individual resource policies and the account-level resource policy.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A continuation token, if the returned list does not contain the last resource policy available.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetResourcePoliciesResponseList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GluePolicy"}
|
||||
},
|
||||
"GetResourcePolicyRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"GlueResourceArn",
|
||||
"documentation":"<p>The ARN of the AWS Glue resource for the resource policy to be retrieved. For more information about AWS Glue resource ARNs, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id\">AWS Glue ARN string pattern</a> </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetResourcePolicyResponse":{
|
||||
|
|
@ -6321,6 +6933,28 @@
|
|||
"documentation":"<p>An encryption operation failed.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"GluePolicy":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PolicyInJson":{
|
||||
"shape":"PolicyJsonString",
|
||||
"documentation":"<p>Contains the requested policy document, in JSON format.</p>"
|
||||
},
|
||||
"PolicyHash":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>Contains the hash value associated with this policy.</p>"
|
||||
},
|
||||
"CreateTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time at which the policy was created.</p>"
|
||||
},
|
||||
"UpdateTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time at which the policy was last updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for returning a resource policy.</p>"
|
||||
},
|
||||
"GlueResourceArn":{
|
||||
"type":"string",
|
||||
"max":10240,
|
||||
|
|
@ -7230,6 +7864,33 @@
|
|||
"type":"string",
|
||||
"enum":["EQUALS"]
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"LongColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"NumberOfNulls",
|
||||
"NumberOfDistinctValues"
|
||||
],
|
||||
"members":{
|
||||
"MinimumValue":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Minimum value of the column.</p>"
|
||||
},
|
||||
"MaximumValue":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Maximum value of the column.</p>"
|
||||
},
|
||||
"NumberOfNulls":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of nulls.</p>"
|
||||
},
|
||||
"NumberOfDistinctValues":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of distinct values.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a long column statistics data.</p>"
|
||||
},
|
||||
"MLTransform":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -7447,6 +8108,10 @@
|
|||
"type":"integer",
|
||||
"min":0
|
||||
},
|
||||
"NonNegativeLong":{
|
||||
"type":"long",
|
||||
"min":0
|
||||
},
|
||||
"NotificationProperty":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -7561,6 +8226,10 @@
|
|||
"LastAnalyzedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The last time at which column statistics were computed for this partition.</p>"
|
||||
},
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the partition resides.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a slice of table data.</p>"
|
||||
|
|
@ -7790,6 +8459,10 @@
|
|||
"shape":"PolicyJsonString",
|
||||
"documentation":"<p>Contains the policy document to set, in JSON format.</p>"
|
||||
},
|
||||
"ResourceArn":{
|
||||
"shape":"GlueResourceArn",
|
||||
"documentation":"<p>The ARN of the AWS Glue resource for the resource policy to be set. For more information about AWS Glue resource ARNs, see the <a href=\"https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-aws-glue-arn-id\">AWS Glue ARN string pattern</a> </p>"
|
||||
},
|
||||
"PolicyHashCondition":{
|
||||
"shape":"HashString",
|
||||
"documentation":"<p>The hash value returned when the previous policy was set using <code>PutResourcePolicy</code>. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.</p>"
|
||||
|
|
@ -7797,6 +8470,10 @@
|
|||
"PolicyExistsCondition":{
|
||||
"shape":"ExistCondition",
|
||||
"documentation":"<p>A value of <code>MUST_EXIST</code> is used to update a policy. A value of <code>NOT_EXIST</code> is used to create a new policy. If a value of <code>NONE</code> or a null value is used, the call will not depend on the existence of a policy.</p>"
|
||||
},
|
||||
"EnableHybrid":{
|
||||
"shape":"EnableHybridValues",
|
||||
"documentation":"<p>Allows you to specify if you want to use both resource-level and account/catalog-level resource policies. A resource-level policy is a policy attached to an individual resource such as a database or a table.</p> <p>The default value of <code>NO</code> indicates that resource-level policies cannot co-exist with an account-level policy. A value of <code>YES</code> means the use of both resource-level and account/catalog-level resource policies is allowed.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -7880,6 +8557,13 @@
|
|||
"documentation":"<p>A resource numerical limit was exceeded.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ResourceShareType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"FOREIGN",
|
||||
"ALL"
|
||||
]
|
||||
},
|
||||
"ResourceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -8076,6 +8760,10 @@
|
|||
"MaxResults":{
|
||||
"shape":"PageSize",
|
||||
"documentation":"<p>The maximum number of tables to return in a single response.</p>"
|
||||
},
|
||||
"ResourceShareType":{
|
||||
"shape":"ResourceShareType",
|
||||
"documentation":"<p>Allows you to specify that you want to search the tables shared with your account. The allowable values are <code>FOREIGN</code> or <code>ALL</code>. </p> <ul> <li> <p>If set to <code>FOREIGN</code>, will search the tables shared with your account. </p> </li> <li> <p>If set to <code>ALL</code>, will search the tables shared with your account, as well as the tables in yor local account. </p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -8559,6 +9247,34 @@
|
|||
},
|
||||
"documentation":"<p>Describes the physical storage of table data.</p>"
|
||||
},
|
||||
"StringColumnStatisticsData":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"MaximumLength",
|
||||
"AverageLength",
|
||||
"NumberOfNulls",
|
||||
"NumberOfDistinctValues"
|
||||
],
|
||||
"members":{
|
||||
"MaximumLength":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Maximum value of the column.</p>"
|
||||
},
|
||||
"AverageLength":{
|
||||
"shape":"NonNegativeDouble",
|
||||
"documentation":"<p>Average value of the column.</p>"
|
||||
},
|
||||
"NumberOfNulls":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of nulls.</p>"
|
||||
},
|
||||
"NumberOfDistinctValues":{
|
||||
"shape":"NonNegativeLong",
|
||||
"documentation":"<p>Number of distinct values.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines a string column statistics data.</p>"
|
||||
},
|
||||
"StringList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GenericString"}
|
||||
|
|
@ -8634,6 +9350,14 @@
|
|||
"IsRegisteredWithLakeFormation":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether the table has been registered with AWS Lake Formation.</p>"
|
||||
},
|
||||
"TargetTable":{
|
||||
"shape":"TableIdentifier",
|
||||
"documentation":"<p>A <code>TableIdentifier</code> structure that describes a target table for resource linking.</p>"
|
||||
},
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the table resides.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a collection of related data organized in columns and rows.</p>"
|
||||
|
|
@ -8656,6 +9380,24 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"TableError"}
|
||||
},
|
||||
"TableIdentifier":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the table resides.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database that contains the target table.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the target table.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure that describes a target table for resource linking.</p>"
|
||||
},
|
||||
"TableInput":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
|
|
@ -8707,6 +9449,10 @@
|
|||
"Parameters":{
|
||||
"shape":"ParametersMap",
|
||||
"documentation":"<p>These key-value pairs define properties associated with the table.</p>"
|
||||
},
|
||||
"TargetTable":{
|
||||
"shape":"TableIdentifier",
|
||||
"documentation":"<p>A <code>TableIdentifier</code> structure that describes a target table for resource linking.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure used to define a table.</p>"
|
||||
|
|
@ -9182,6 +9928,12 @@
|
|||
},
|
||||
"documentation":"<p>A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.</p>"
|
||||
},
|
||||
"TypeString":{
|
||||
"type":"string",
|
||||
"max":20000,
|
||||
"min":0,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*"
|
||||
},
|
||||
"URI":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
|
|
@ -9243,6 +9995,87 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateColumnStatisticsForPartitionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"TableName",
|
||||
"PartitionValues",
|
||||
"ColumnStatisticsList"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the partitions reside.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the partitions' table.</p>"
|
||||
},
|
||||
"PartitionValues":{
|
||||
"shape":"ValueStringList",
|
||||
"documentation":"<p>A list of partition values identifying the partition.</p>"
|
||||
},
|
||||
"ColumnStatisticsList":{
|
||||
"shape":"UpdateColumnStatisticsList",
|
||||
"documentation":"<p>A list of the column statistics.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateColumnStatisticsForPartitionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Errors":{
|
||||
"shape":"ColumnStatisticsErrors",
|
||||
"documentation":"<p>Error occurred during updating column statistics data.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateColumnStatisticsForTableRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"TableName",
|
||||
"ColumnStatisticsList"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the catalog database where the partitions reside.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the partitions' table.</p>"
|
||||
},
|
||||
"ColumnStatisticsList":{
|
||||
"shape":"UpdateColumnStatisticsList",
|
||||
"documentation":"<p>A list of the column statistics.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateColumnStatisticsForTableResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Errors":{
|
||||
"shape":"ColumnStatisticsErrors",
|
||||
"documentation":"<p>List of ColumnStatisticsErrors.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateColumnStatisticsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ColumnStatistics"},
|
||||
"max":25,
|
||||
"min":0
|
||||
},
|
||||
"UpdateConnectionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -9749,7 +10582,7 @@
|
|||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the database where the function resides.</p>"
|
||||
"documentation":"<p>The name of the catalog database that contains the function.</p>"
|
||||
},
|
||||
"ClassName":{
|
||||
"shape":"NameString",
|
||||
|
|
@ -9770,6 +10603,10 @@
|
|||
"ResourceUris":{
|
||||
"shape":"ResourceUriList",
|
||||
"documentation":"<p>The resource URIs for the function.</p>"
|
||||
},
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The ID of the Data Catalog in which the function resides.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the equivalent of a Hive user-defined function (<code>UDF</code>) definition.</p>"
|
||||
|
|
|
|||
3
botocore/data/honeycode/2020-03-01/paginators-1.json
Normal file
3
botocore/data/honeycode/2020-03-01/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
411
botocore/data/honeycode/2020-03-01/service-2.json
Normal file
411
botocore/data/honeycode/2020-03-01/service-2.json
Normal file
|
|
@ -0,0 +1,411 @@
|
|||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2020-03-01",
|
||||
"endpointPrefix":"honeycode",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"rest-json",
|
||||
"serviceAbbreviation":"Honeycode",
|
||||
"serviceFullName":"Amazon Honeycode",
|
||||
"serviceId":"Honeycode",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"honeycode",
|
||||
"uid":"honeycode-2020-03-01"
|
||||
},
|
||||
"operations":{
|
||||
"GetScreenData":{
|
||||
"name":"GetScreenData",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/screendata"
|
||||
},
|
||||
"input":{"shape":"GetScreenDataRequest"},
|
||||
"output":{"shape":"GetScreenDataResult"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"RequestTimeoutException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p> The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen. </p>"
|
||||
},
|
||||
"InvokeScreenAutomation":{
|
||||
"name":"InvokeScreenAutomation",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}"
|
||||
},
|
||||
"input":{"shape":"InvokeScreenAutomationRequest"},
|
||||
"output":{"shape":"InvokeScreenAutomationResult"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ServiceUnavailableException"},
|
||||
{"shape":"AutomationExecutionException"},
|
||||
{"shape":"AutomationExecutionTimeoutException"},
|
||||
{"shape":"RequestTimeoutException"}
|
||||
],
|
||||
"documentation":"<p> The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessDeniedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the screen/automation in the request. </p>",
|
||||
"error":{"httpStatusCode":403},
|
||||
"exception":true
|
||||
},
|
||||
"AutomationExecutionException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>The automation execution did not end successfully.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"AutomationExecutionTimeoutException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>The automation execution timed out.</p>",
|
||||
"error":{"httpStatusCode":504},
|
||||
"exception":true
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":32
|
||||
},
|
||||
"ColumnMetadata":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"name",
|
||||
"format"
|
||||
],
|
||||
"members":{
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the column.</p>"
|
||||
},
|
||||
"format":{
|
||||
"shape":"Format",
|
||||
"documentation":"<p>The format of the column.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Metadata for column in the table.</p>"
|
||||
},
|
||||
"DataItem":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"overrideFormat":{
|
||||
"shape":"Format",
|
||||
"documentation":"<p> The overrideFormat is optional and is specified only if a particular row of data has a different format for the data than the default format defined on the screen or the table. </p>"
|
||||
},
|
||||
"rawValue":{
|
||||
"shape":"RawValue",
|
||||
"documentation":"<p>The raw value of the data. e.g. jsmith@example.com</p>"
|
||||
},
|
||||
"formattedValue":{
|
||||
"shape":"FormattedValue",
|
||||
"documentation":"<p>The formatted value of the data. e.g. John Smith.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The data in a particular data cell defined on the screen.</p>",
|
||||
"sensitive":true
|
||||
},
|
||||
"DataItems":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DataItem"}
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"Format":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"AUTO",
|
||||
"NUMBER",
|
||||
"CURRENCY",
|
||||
"DATE",
|
||||
"TIME",
|
||||
"DATE_TIME",
|
||||
"PERCENTAGE",
|
||||
"TEXT",
|
||||
"ACCOUNTING",
|
||||
"CONTACT",
|
||||
"ROWLINK"
|
||||
]
|
||||
},
|
||||
"FormattedValue":{"type":"string"},
|
||||
"GetScreenDataRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"workbookId",
|
||||
"appId",
|
||||
"screenId"
|
||||
],
|
||||
"members":{
|
||||
"workbookId":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The ID of the workbook that contains the screen.</p>"
|
||||
},
|
||||
"appId":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The ID of the app that contains the screem.</p>"
|
||||
},
|
||||
"screenId":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The ID of the screen.</p>"
|
||||
},
|
||||
"variables":{
|
||||
"shape":"VariableValueMap",
|
||||
"documentation":"<p> Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. </p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p> The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100. </p> <p> This parameter is optional. If you don't specify this parameter, the default page size is 100. </p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p> This parameter is optional. If a nextToken is not specified, the API returns the first page of data. </p> <p> Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetScreenDataResult":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"results",
|
||||
"workbookCursor"
|
||||
],
|
||||
"members":{
|
||||
"results":{
|
||||
"shape":"ResultSetMap",
|
||||
"documentation":"<p>A map of all the rows on the screen keyed by block name.</p>"
|
||||
},
|
||||
"workbookCursor":{
|
||||
"shape":"WorkbookCursor",
|
||||
"documentation":"<p> Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential. </p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p> Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"InternalServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>There were unexpected errors from the server.</p>",
|
||||
"error":{"httpStatusCode":500},
|
||||
"exception":true
|
||||
},
|
||||
"InvokeScreenAutomationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"workbookId",
|
||||
"appId",
|
||||
"screenId",
|
||||
"screenAutomationId"
|
||||
],
|
||||
"members":{
|
||||
"workbookId":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The ID of the workbook that contains the screen automation.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"workbookId"
|
||||
},
|
||||
"appId":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The ID of the app that contains the screen automation.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"appId"
|
||||
},
|
||||
"screenId":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The ID of the screen that contains the screen automation.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"screenId"
|
||||
},
|
||||
"screenAutomationId":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The ID of the automation action to be performed.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"automationId"
|
||||
},
|
||||
"variables":{
|
||||
"shape":"VariableValueMap",
|
||||
"documentation":"<p> Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. </p>"
|
||||
},
|
||||
"rowId":{
|
||||
"shape":"RowId",
|
||||
"documentation":"<p> The row ID for the automation if the automation is defined inside a block with source or list. </p>"
|
||||
},
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p> The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again. </p> <p> Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"InvokeScreenAutomationResult":{
|
||||
"type":"structure",
|
||||
"required":["workbookCursor"],
|
||||
"members":{
|
||||
"workbookCursor":{
|
||||
"shape":"WorkbookCursor",
|
||||
"documentation":"<p>The updated workbook cursor after performing the automation action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"Name":{
|
||||
"type":"string",
|
||||
"sensitive":true
|
||||
},
|
||||
"PaginationToken":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":1
|
||||
},
|
||||
"RawValue":{"type":"string"},
|
||||
"RequestTimeoutException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>The request timed out.</p>",
|
||||
"error":{"httpStatusCode":504},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceId":{
|
||||
"type":"string",
|
||||
"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>A Workbook, App, Screen or Screen Automation was not found with the given ID.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"ResultHeader":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ColumnMetadata"}
|
||||
},
|
||||
"ResultRow":{
|
||||
"type":"structure",
|
||||
"required":["dataItems"],
|
||||
"members":{
|
||||
"rowId":{
|
||||
"shape":"RowId",
|
||||
"documentation":"<p>The ID for a particular row.</p>"
|
||||
},
|
||||
"dataItems":{
|
||||
"shape":"DataItems",
|
||||
"documentation":"<p>List of all the data cells in a row.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A single row in the ResultSet.</p>"
|
||||
},
|
||||
"ResultRows":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResultRow"}
|
||||
},
|
||||
"ResultSet":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"headers",
|
||||
"rows"
|
||||
],
|
||||
"members":{
|
||||
"headers":{
|
||||
"shape":"ResultHeader",
|
||||
"documentation":"<p> List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used. </p> <p> For example, a task list that displays the task name, due date and assigned person might have headers [ { \"name\": \"Task Name\"}, {\"name\": \"Due Date\", \"format\": \"DATE\"}, {\"name\": \"Assigned\", \"format\": \"CONTACT\"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element. </p>"
|
||||
},
|
||||
"rows":{
|
||||
"shape":"ResultRows",
|
||||
"documentation":"<p> List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> ResultSet contains the results of the request for a single block or list defined on the screen. </p>"
|
||||
},
|
||||
"ResultSetMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"Name"},
|
||||
"value":{"shape":"ResultSet"}
|
||||
},
|
||||
"RowId":{
|
||||
"type":"string",
|
||||
"pattern":"row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"
|
||||
},
|
||||
"ServiceUnavailableException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Remote service is unreachable.</p>",
|
||||
"error":{"httpStatusCode":503},
|
||||
"exception":true
|
||||
},
|
||||
"ThrottlingException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Tps(transactions per second) rate reached.</p>",
|
||||
"error":{"httpStatusCode":429},
|
||||
"exception":true
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"required":["message"],
|
||||
"members":{
|
||||
"message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p> Request is invalid. The message in the response contains details on why the request is invalid. </p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"VariableName":{
|
||||
"type":"string",
|
||||
"sensitive":true
|
||||
},
|
||||
"VariableValue":{
|
||||
"type":"structure",
|
||||
"required":["rawValue"],
|
||||
"members":{
|
||||
"rawValue":{
|
||||
"shape":"RawValue",
|
||||
"documentation":"<p>Raw value of the variable.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input variables to the app to be used by the InvokeScreenAutomation action request.</p>",
|
||||
"sensitive":true
|
||||
},
|
||||
"VariableValueMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"VariableName"},
|
||||
"value":{"shape":"VariableValue"},
|
||||
"sensitive":true
|
||||
},
|
||||
"WorkbookCursor":{"type":"long"}
|
||||
},
|
||||
"documentation":"<p> Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team. </p>"
|
||||
}
|
||||
|
|
@ -42,7 +42,7 @@
|
|||
{"shape":"UnmodifiableEntityException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of AWS because of <a href=\"https://en.wikipedia.org/wiki/Eventual_consistency\">eventual consistency</a>. To force the change, you must <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html\">disassociate the instance profile</a> and then <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html\">associate the instance profile</a>, or you can stop your instance and then restart it.</p> <note> <p>The caller of this API must be granted the <code>PassRole</code> permission on the IAM role by a permissions policy.</p> </note> <p>For more information about roles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. For more information about instance profiles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>.</p>"
|
||||
"documentation":"<p>Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role. (The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.) You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of AWS because of <a href=\"https://en.wikipedia.org/wiki/Eventual_consistency\">eventual consistency</a>. To force the change, you must <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIamInstanceProfile.html\">disassociate the instance profile</a> and then <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateIamInstanceProfile.html\">associate the instance profile</a>, or you can stop your instance and then restart it.</p> <note> <p>The caller of this API must be granted the <code>PassRole</code> permission on the IAM role by a permissions policy.</p> </note> <p>For more information about roles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. For more information about instance profiles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>.</p>"
|
||||
},
|
||||
"AddUserToGroup":{
|
||||
"name":"AddUserToGroup",
|
||||
|
|
@ -140,7 +140,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users.</p> <p> For information about limits on the number of keys you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p> <important> <p>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.</p> </important>"
|
||||
"documentation":"<p> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users.</p> <p>The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.</p> </important>"
|
||||
},
|
||||
"CreateAccountAlias":{
|
||||
"name":"CreateAccountAlias",
|
||||
|
|
@ -173,7 +173,7 @@
|
|||
{"shape":"NoSuchEntityException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new group.</p> <p> For information about the number of groups you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates a new group.</p> <p>The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.</p>"
|
||||
},
|
||||
"CreateInstanceProfile":{
|
||||
"name":"CreateInstanceProfile",
|
||||
|
|
@ -191,7 +191,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p> Creates a new instance profile. For information about instance profiles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>.</p> <p> For information about the number of instance profiles you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p>"
|
||||
"documentation":"<p> Creates a new instance profile. For information about instance profiles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>.</p> <p>The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.</p>"
|
||||
},
|
||||
"CreateLoginProfile":{
|
||||
"name":"CreateLoginProfile",
|
||||
|
|
@ -291,7 +291,7 @@
|
|||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new role for your AWS account. For more information about roles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">IAM Roles</a>. For information about limitations on role names and the number of roles you can create, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates a new role for your AWS account. For more information about roles, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">IAM Roles</a>. The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.</p>"
|
||||
},
|
||||
"CreateSAMLProvider":{
|
||||
"name":"CreateSAMLProvider",
|
||||
|
|
@ -368,7 +368,7 @@
|
|||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new IAM user for your AWS account.</p> <p> For information about limitations on the number of IAM users you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p>"
|
||||
"documentation":"<p>Creates a new IAM user for your AWS account.</p> <p>The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.</p>"
|
||||
},
|
||||
"CreateVirtualMFADevice":{
|
||||
"name":"CreateVirtualMFADevice",
|
||||
|
|
@ -386,7 +386,7 @@
|
|||
{"shape":"EntityAlreadyExistsException"},
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Using a Virtual MFA Device</a> in the <i>IAM User Guide</i>.</p> <p>For information about limits on the number of MFA devices you can create, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on Entities</a> in the <i>IAM User Guide</i>.</p> <important> <p>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.</p> </important>"
|
||||
"documentation":"<p>Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Using a Virtual MFA Device</a> in the <i>IAM User Guide</i>.</p> <p>The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.</p> <important> <p>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.</p> </important>"
|
||||
},
|
||||
"DeactivateMFADevice":{
|
||||
"name":"DeactivateMFADevice",
|
||||
|
|
@ -909,7 +909,7 @@
|
|||
"errors":[
|
||||
{"shape":"ServiceFailureException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves information about IAM entity usage and IAM quotas in the AWS account.</p> <p> For information about limitations on IAM entities, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>.</p>"
|
||||
"documentation":"<p>Retrieves information about IAM entity usage and IAM quotas in the AWS account.</p> <p>The number and size of IAM resources in an AWS account are limited. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS Quotas</a> in the <i>IAM User Guide</i>.</p>"
|
||||
},
|
||||
"GetContextKeysForCustomPolicy":{
|
||||
"name":"GetContextKeysForCustomPolicy",
|
||||
|
|
@ -4681,7 +4681,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"limitExceededMessage"}
|
||||
},
|
||||
"documentation":"<p>The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.</p>",
|
||||
"documentation":"<p>The request was rejected because it attempted to create resources beyond the current AWS account limitations. The error message describes the limit exceeded.</p>",
|
||||
"error":{
|
||||
"code":"LimitExceeded",
|
||||
"httpStatusCode":409,
|
||||
|
|
|
|||
|
|
@ -868,6 +868,10 @@
|
|||
"shape":"TagMap",
|
||||
"documentation":"<p>The tags to apply to AMIs distributed to this Region. </p>"
|
||||
},
|
||||
"kmsKeyId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p> The KMS key identifier used to encrypt the distributed image. </p>"
|
||||
},
|
||||
"launchPermission":{
|
||||
"shape":"LaunchPermissionConfiguration",
|
||||
"documentation":"<p> Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances. </p>"
|
||||
|
|
@ -2827,7 +2831,7 @@
|
|||
"documentation":"<p>The name of the group. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the configuration for a launch permission. The launch permission modification request is sent to the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html\">EC2 ModifyImageAttribute</a> API on behalf of the user for each Region they have selected to distribute the AMI.</p>"
|
||||
"documentation":"<p>Describes the configuration for a launch permission. The launch permission modification request is sent to the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html\">EC2 ModifyImageAttribute</a> API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to <code>all</code>. See the examples for making an AMI public at <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyImageAttribute.html\">EC2 ModifyImageAttribute</a>. </p>"
|
||||
},
|
||||
"ListComponentBuildVersionsRequest":{
|
||||
"type":"structure",
|
||||
|
|
|
|||
|
|
@ -3164,10 +3164,6 @@
|
|||
},
|
||||
"GetAssetPropertyValueHistoryRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"startDate",
|
||||
"endDate"
|
||||
],
|
||||
"members":{
|
||||
"assetId":{
|
||||
"shape":"ID",
|
||||
|
|
|
|||
22
botocore/data/ivs/2020-07-14/paginators-1.json
Normal file
22
botocore/data/ivs/2020-07-14/paginators-1.json
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
{
|
||||
"pagination": {
|
||||
"ListChannels": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"result_key": "channels"
|
||||
},
|
||||
"ListStreamKeys": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"result_key": "streamKeys"
|
||||
},
|
||||
"ListStreams": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"result_key": "streams"
|
||||
}
|
||||
}
|
||||
}
|
||||
1082
botocore/data/ivs/2020-07-14/service-2.json
Normal file
1082
botocore/data/ivs/2020-07-14/service-2.json
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -86,7 +86,7 @@
|
|||
{"shape":"InvalidInputException"},
|
||||
{"shape":"EntityNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
"documentation":"<p>Retrieves the list of the data lake administrators of a Lake Formation-managed data lake. </p>"
|
||||
},
|
||||
"GetEffectivePermissionsForPath":{
|
||||
"name":"GetEffectivePermissionsForPath",
|
||||
|
|
@ -102,7 +102,7 @@
|
|||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Returns the permissions for a specified table or database resource located at a path in Amazon S3.</p>"
|
||||
"documentation":"<p>Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. <code>GetEffectivePermissionsForPath</code> will not return databases and tables if the catalog is encrypted.</p>"
|
||||
},
|
||||
"GrantPermissions":{
|
||||
"name":"GrantPermissions",
|
||||
|
|
@ -117,7 +117,7 @@
|
|||
{"shape":"EntityNotFoundException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"documentation":"<p>Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.</p> <p>For information about permissions, see <a href=\"https://docs-aws.amazon.com/michigan/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
"documentation":"<p>Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.</p> <p>For information about permissions, see <a href=\"https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
},
|
||||
"ListPermissions":{
|
||||
"name":"ListPermissions",
|
||||
|
|
@ -132,7 +132,7 @@
|
|||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.</p> <p>This operation returns only those permissions that have been explicitly granted.</p> <p>For information about permissions, see <a href=\"https://docs-aws.amazon.com/michigan/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
"documentation":"<p>Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.</p> <p>This operation returns only those permissions that have been explicitly granted.</p> <p>For information about permissions, see <a href=\"https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
},
|
||||
"ListResources":{
|
||||
"name":"ListResources",
|
||||
|
|
@ -161,7 +161,7 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
],
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
"documentation":"<p>Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see <a href=\"https://docs.aws.amazon.com/lake-formation/latest/dg/lake-formation-permissions.html\">Granting Lake Formation Permissions</a>.</p> <p>This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.</p>"
|
||||
},
|
||||
"RegisterResource":{
|
||||
"name":"RegisterResource",
|
||||
|
|
@ -177,7 +177,7 @@
|
|||
{"shape":"OperationTimeoutException"},
|
||||
{"shape":"AlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p>Registers the resource as managed by the Data Catalog.</p> <p>To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.</p>"
|
||||
"documentation":"<p>Registers the resource as managed by the Data Catalog.</p> <p>To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.</p> <p>The following request registers a new location and gives AWS Lake Formation permission to use the service-linked role to access that location.</p> <p> <code>ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true</code> </p> <p>If <code>UseServiceLinkedRole</code> is not set to true, you must provide or set the <code>RoleArn</code>:</p> <p> <code>arn:aws:iam::12345:role/my-data-access-role</code> </p>"
|
||||
},
|
||||
"RevokePermissions":{
|
||||
"name":"RevokePermissions",
|
||||
|
|
@ -379,7 +379,7 @@
|
|||
"documentation":"<p>An identifier for the AWS Lake Formation principal.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
"documentation":"<p>The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.</p>"
|
||||
},
|
||||
"DataLakePrincipalList":{
|
||||
"type":"list",
|
||||
|
|
@ -406,23 +406,31 @@
|
|||
"members":{
|
||||
"DataLakeAdmins":{
|
||||
"shape":"DataLakePrincipalList",
|
||||
"documentation":"<p>A list of AWS Lake Formation principals.</p>"
|
||||
"documentation":"<p>A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.</p>"
|
||||
},
|
||||
"CreateDatabaseDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>A list of up to three principal permissions entries for default create database permissions.</p>"
|
||||
"documentation":"<p>A structure representing a list of up to three principal permissions entries for default create database permissions.</p>"
|
||||
},
|
||||
"CreateTableDefaultPermissions":{
|
||||
"shape":"PrincipalPermissionsList",
|
||||
"documentation":"<p>A list of up to three principal permissions entries for default create table permissions.</p>"
|
||||
"documentation":"<p>A structure representing a list of up to three principal permissions entries for default create table permissions.</p>"
|
||||
},
|
||||
"TrustedResourceOwners":{
|
||||
"shape":"TrustedResourceOwners",
|
||||
"documentation":"<p>A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's AWS CloudTrail log.</p> <p>You may want to specify this property when you are in a high-trust boundary, such as the same team or company. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The AWS Lake Formation principal.</p>"
|
||||
"documentation":"<p>A structure representing a list of AWS Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.</p>"
|
||||
},
|
||||
"DataLocationResource":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog where the location is registered with AWS Lake Formation. By default, it is the account ID of the caller.</p>"
|
||||
},
|
||||
"ResourceArn":{
|
||||
"shape":"ResourceArnString",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that uniquely identifies the data location resource.</p>"
|
||||
|
|
@ -434,6 +442,10 @@
|
|||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, it is the account ID of the caller.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the database resource. Unique to the Data Catalog.</p>"
|
||||
|
|
@ -552,7 +564,7 @@
|
|||
"members":{
|
||||
"DataLakeSettings":{
|
||||
"shape":"DataLakeSettings",
|
||||
"documentation":"<p>A list of AWS Lake Formation principals. </p>"
|
||||
"documentation":"<p>A structure representing a list of AWS Lake Formation principals designated as data lake administrators.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -768,6 +780,7 @@
|
|||
"DROP",
|
||||
"DELETE",
|
||||
"INSERT",
|
||||
"DESCRIBE",
|
||||
"CREATE_DATABASE",
|
||||
"CREATE_TABLE",
|
||||
"DATA_LOCATION_ACCESS"
|
||||
|
|
@ -831,7 +844,7 @@
|
|||
},
|
||||
"DataLakeSettings":{
|
||||
"shape":"DataLakeSettings",
|
||||
"documentation":"<p>A list of AWS Lake Formation principals.</p>"
|
||||
"documentation":"<p>A structure representing a list of AWS Lake Formation principals designated as data lake administrators.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -850,11 +863,11 @@
|
|||
},
|
||||
"UseServiceLinkedRole":{
|
||||
"shape":"NullableBoolean",
|
||||
"documentation":"<p>Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog. </p>"
|
||||
"documentation":"<p>Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.</p> <p>For more information, see <a href=\"https://docs-aws.amazon.com/lake-formation/latest/dg/service-linked-roles.html\">Using Service-Linked Roles for Lake Formation</a>.</p>"
|
||||
},
|
||||
"RoleArn":{
|
||||
"shape":"IAMRoleArn",
|
||||
"documentation":"<p>The identifier for the role.</p>"
|
||||
"documentation":"<p>The identifier for the role that registers the resource.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -934,7 +947,7 @@
|
|||
},
|
||||
"Permissions":{
|
||||
"shape":"PermissionList",
|
||||
"documentation":"<p>The permissions revoked to the principal on the resource. For information about permissions, see <a href=\"https://docs-aws.amazon.com/michigan/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
"documentation":"<p>The permissions revoked to the principal on the resource. For information about permissions, see <a href=\"https://docs-aws.amazon.com/lake-formation/latest/dg/security-data-access.html\">Security and Access Control to Metadata and Data</a>.</p>"
|
||||
},
|
||||
"PermissionsWithGrantOption":{
|
||||
"shape":"PermissionList",
|
||||
|
|
@ -954,11 +967,12 @@
|
|||
},
|
||||
"TableResource":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"Name"
|
||||
],
|
||||
"required":["DatabaseName"],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, it is the account ID of the caller.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. </p>"
|
||||
|
|
@ -966,13 +980,31 @@
|
|||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the table.</p>"
|
||||
},
|
||||
"TableWildcard":{
|
||||
"shape":"TableWildcard",
|
||||
"documentation":"<p>A wildcard object representing every table under a database.</p> <p>At least one of <code>TableResource$Name</code> or <code>TableResource$TableWildcard</code> is required.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal. </p>"
|
||||
},
|
||||
"TableWithColumnsResource":{
|
||||
"TableWildcard":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>A wildcard object representing every table under a database.</p>"
|
||||
},
|
||||
"TableWithColumnsResource":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DatabaseName",
|
||||
"Name"
|
||||
],
|
||||
"members":{
|
||||
"CatalogId":{
|
||||
"shape":"CatalogIdString",
|
||||
"documentation":"<p>The identifier for the Data Catalog. By default, it is the account ID of the caller.</p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal. </p>"
|
||||
|
|
@ -993,6 +1025,10 @@
|
|||
"documentation":"<p>A structure for a table with columns object. This object is only used when granting a SELECT permission.</p> <p>This object must take a value for at least one of <code>ColumnsNames</code>, <code>ColumnsIndexes</code>, or <code>ColumnsWildcard</code>.</p>"
|
||||
},
|
||||
"Token":{"type":"string"},
|
||||
"TrustedResourceOwners":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CatalogIdString"}
|
||||
},
|
||||
"UpdateResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -46,7 +46,7 @@
|
|||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.</p> <p>A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The <code>CreateDashboard</code>, <code>DescribeDashboard</code>, and <code>ListDashboardsByUser</code> API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.</p>"
|
||||
"documentation":"<p>Creates a dashboard from a template. To first create a template, see the <a>CreateTemplate</a> API operation.</p> <p>A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The <code>CreateDashboard</code>, <code>DescribeDashboard</code>, and <code>ListDashboardsByUser</code> API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.</p>"
|
||||
},
|
||||
"CreateDataSet":{
|
||||
"name":"CreateDataSet",
|
||||
|
|
@ -183,6 +183,7 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.</p> <p>A <i>template</i> is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.</p>"
|
||||
|
|
@ -202,10 +203,51 @@
|
|||
{"shape":"ResourceExistsException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a template alias for a template.</p>"
|
||||
},
|
||||
"CreateTheme":{
|
||||
"name":"CreateTheme",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
|
||||
},
|
||||
"input":{"shape":"CreateThemeRequest"},
|
||||
"output":{"shape":"CreateThemeResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceExistsException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a theme.</p> <p>A <i>theme</i> is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html\">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
|
||||
},
|
||||
"CreateThemeAlias":{
|
||||
"name":"CreateThemeAlias",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
|
||||
},
|
||||
"input":{"shape":"CreateThemeAliasRequest"},
|
||||
"output":{"shape":"CreateThemeAliasResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceExistsException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Creates a theme alias for a theme.</p>"
|
||||
},
|
||||
"DeleteDashboard":{
|
||||
"name":"DeleteDashboard",
|
||||
"http":{
|
||||
|
|
@ -346,10 +388,48 @@
|
|||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.</p>"
|
||||
},
|
||||
"DeleteTheme":{
|
||||
"name":"DeleteTheme",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
|
||||
},
|
||||
"input":{"shape":"DeleteThemeRequest"},
|
||||
"output":{"shape":"DeleteThemeResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a theme.</p>"
|
||||
},
|
||||
"DeleteThemeAlias":{
|
||||
"name":"DeleteThemeAlias",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
|
||||
},
|
||||
"input":{"shape":"DeleteThemeAliasRequest"},
|
||||
"output":{"shape":"DeleteThemeAliasResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.</p>"
|
||||
},
|
||||
"DeleteUser":{
|
||||
"name":"DeleteUser",
|
||||
"http":{
|
||||
|
|
@ -598,6 +678,61 @@
|
|||
],
|
||||
"documentation":"<p>Describes read and write permissions on a template.</p>"
|
||||
},
|
||||
"DescribeTheme":{
|
||||
"name":"DescribeTheme",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
|
||||
},
|
||||
"input":{"shape":"DescribeThemeRequest"},
|
||||
"output":{"shape":"DescribeThemeResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceExistsException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Describes a theme.</p>"
|
||||
},
|
||||
"DescribeThemeAlias":{
|
||||
"name":"DescribeThemeAlias",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
|
||||
},
|
||||
"input":{"shape":"DescribeThemeAliasRequest"},
|
||||
"output":{"shape":"DescribeThemeAliasResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Describes the alias for a theme.</p>"
|
||||
},
|
||||
"DescribeThemePermissions":{
|
||||
"name":"DescribeThemePermissions",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/permissions"
|
||||
},
|
||||
"input":{"shape":"DescribeThemePermissionsRequest"},
|
||||
"output":{"shape":"DescribeThemePermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Describes the read and write permissions for a theme.</p>"
|
||||
},
|
||||
"DescribeUser":{
|
||||
"name":"DescribeUser",
|
||||
"http":{
|
||||
|
|
@ -637,7 +772,7 @@
|
|||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html\">Embedding Amazon QuickSight Dashboards</a> in the <i>Amazon QuickSight User Guide</i> or <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html\">Embedding Amazon QuickSight Dashboards</a> in the <i>Amazon QuickSight API Reference</i>.</p> <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user’s browser.</p>"
|
||||
"documentation":"<p>Generates a URL and authorization code that you can embed in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. </p> <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:</p> <ul> <li> <p>They must be used together.</p> </li> <li> <p>They can be used one time only.</p> </li> <li> <p>They are valid for 5 minutes after you run this command.</p> </li> <li> <p>The resulting user session is valid for 10 hours.</p> </li> </ul> <p> For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html\">Embedding Amazon QuickSight Dashboards</a> in the <i>Amazon QuickSight User Guide</i> or <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html\">Embedding Amazon QuickSight Dashboards</a> in the <i>Amazon QuickSight API Reference</i>.</p>"
|
||||
},
|
||||
"ListDashboardVersions":{
|
||||
"name":"ListDashboardVersions",
|
||||
|
|
@ -829,6 +964,7 @@
|
|||
"input":{"shape":"ListTemplateAliasesRequest"},
|
||||
"output":{"shape":"ListTemplateAliasesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
|
|
@ -872,6 +1008,63 @@
|
|||
],
|
||||
"documentation":"<p>Lists all the templates in the current Amazon QuickSight account.</p>"
|
||||
},
|
||||
"ListThemeAliases":{
|
||||
"name":"ListThemeAliases",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases"
|
||||
},
|
||||
"input":{"shape":"ListThemeAliasesRequest"},
|
||||
"output":{"shape":"ListThemeAliasesResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Lists all the aliases of a theme.</p>"
|
||||
},
|
||||
"ListThemeVersions":{
|
||||
"name":"ListThemeVersions",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/versions"
|
||||
},
|
||||
"input":{"shape":"ListThemeVersionsRequest"},
|
||||
"output":{"shape":"ListThemeVersionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Lists all the versions of the themes in the current AWS account.</p>"
|
||||
},
|
||||
"ListThemes":{
|
||||
"name":"ListThemes",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes"
|
||||
},
|
||||
"input":{"shape":"ListThemesRequest"},
|
||||
"output":{"shape":"ListThemesResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Lists all the themes in the current AWS account.</p>"
|
||||
},
|
||||
"ListUserGroups":{
|
||||
"name":"ListUserGroups",
|
||||
"http":{
|
||||
|
|
@ -1183,6 +1376,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates the template alias of a template.</p>"
|
||||
|
|
@ -1205,6 +1399,63 @@
|
|||
],
|
||||
"documentation":"<p>Updates the resource permissions for a template.</p>"
|
||||
},
|
||||
"UpdateTheme":{
|
||||
"name":"UpdateTheme",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
|
||||
},
|
||||
"input":{"shape":"UpdateThemeRequest"},
|
||||
"output":{"shape":"UpdateThemeResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceExistsException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates a theme.</p>"
|
||||
},
|
||||
"UpdateThemeAlias":{
|
||||
"name":"UpdateThemeAlias",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
|
||||
},
|
||||
"input":{"shape":"UpdateThemeAliasRequest"},
|
||||
"output":{"shape":"UpdateThemeAliasResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceExistsException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates an alias of a theme.</p>"
|
||||
},
|
||||
"UpdateThemePermissions":{
|
||||
"name":"UpdateThemePermissions",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/permissions"
|
||||
},
|
||||
"input":{"shape":"UpdateThemePermissionsRequest"},
|
||||
"output":{"shape":"UpdateThemePermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"UnsupportedUserEditionException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
],
|
||||
"documentation":"<p>Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example <code>\"quicksight:DescribeTheme\"</code>.</p> <p>Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: </p> <ul> <li> <p>User</p> <ul> <li> <p> <code>\"quicksight:DescribeTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:DescribeThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeAliases\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeVersions\"</code> </p> </li> </ul> </li> <li> <p>Owner</p> <ul> <li> <p> <code>\"quicksight:DescribeTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:DescribeThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeAliases\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeVersions\"</code> </p> </li> <li> <p> <code>\"quicksight:DeleteTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:UpdateTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:CreateThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:DeleteThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:UpdateThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:UpdateThemePermissions\"</code> </p> </li> <li> <p> <code>\"quicksight:DescribeThemePermissions\"</code> </p> </li> </ul> </li> <li> <p>To specify no permissions, omit the permissions list.</p> </li> </ul>"
|
||||
},
|
||||
"UpdateUser":{
|
||||
"name":"UpdateUser",
|
||||
"http":{
|
||||
|
|
@ -1360,6 +1611,10 @@
|
|||
"min":12,
|
||||
"pattern":"^[0-9]{12}$"
|
||||
},
|
||||
"AwsAndAccountId":{
|
||||
"type":"string",
|
||||
"pattern":"^(aws|[0-9]{12})$"
|
||||
},
|
||||
"AwsIotAnalyticsParameters":{
|
||||
"type":"structure",
|
||||
"required":["DataSetName"],
|
||||
|
|
@ -1372,6 +1627,17 @@
|
|||
"documentation":"<p>AWS IoT Analytics parameters.</p>"
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"BorderStyle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Show":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>The option to enable display of borders for visuals.</p>",
|
||||
"box":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The display options for tile borders for visuals.</p>"
|
||||
},
|
||||
"CalculatedColumn":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1482,6 +1748,11 @@
|
|||
"max":64,
|
||||
"min":1
|
||||
},
|
||||
"ColorList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"HexColor"},
|
||||
"max":100
|
||||
},
|
||||
"ColumnDataType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -1593,7 +1864,7 @@
|
|||
"documentation":"<p>A geospatial role for a column.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A tag for a column in a <code>TagColumnOperation</code> structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
|
||||
"documentation":"<p>A tag for a column in a <a>TagColumnOperation</a> structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
|
||||
},
|
||||
"ColumnTagList":{
|
||||
"type":"list",
|
||||
|
|
@ -1624,6 +1895,10 @@
|
|||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"CopySourceArn":{
|
||||
"type":"string",
|
||||
"pattern":"^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+"
|
||||
},
|
||||
"CreateColumnsOperation":{
|
||||
"type":"structure",
|
||||
"required":["Columns"],
|
||||
|
|
@ -1662,7 +1937,7 @@
|
|||
},
|
||||
"Parameters":{
|
||||
"shape":"Parameters",
|
||||
"documentation":"<p>A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values. You can use the dashboard permissions structure described following to override two string parameters that accept multiple values. </p>"
|
||||
"documentation":"<p>The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values. </p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"ResourcePermissionList",
|
||||
|
|
@ -1670,7 +1945,7 @@
|
|||
},
|
||||
"SourceEntity":{
|
||||
"shape":"DashboardSourceEntity",
|
||||
"documentation":"<p>The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template. </p> <p>If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.</p>"
|
||||
"documentation":"<p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <a>CreateTemplate</a> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -1682,7 +1957,11 @@
|
|||
},
|
||||
"DashboardPublishOptions":{
|
||||
"shape":"DashboardPublishOptions",
|
||||
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .csv format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. The sheet controls pane is collapsed by default when set to true. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
|
||||
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .csv format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
|
||||
},
|
||||
"ThemeArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1691,7 +1970,7 @@
|
|||
"members":{
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the dashboard.</p>"
|
||||
"documentation":"<p>The ARN of the dashboard.</p>"
|
||||
},
|
||||
"VersionArn":{
|
||||
"shape":"Arn",
|
||||
|
|
@ -2190,7 +2469,7 @@
|
|||
},
|
||||
"SourceEntity":{
|
||||
"shape":"TemplateSourceEntity",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the source entity from which this template is being created. Currently, you can create a template from an analysis or another template. If the ARN is for an analysis, include its dataset references. </p>"
|
||||
"documentation":"<p>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -2232,6 +2511,135 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"CreateThemeAliasRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId",
|
||||
"AliasName",
|
||||
"ThemeVersionNumber"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme for the new theme alias.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>An ID for the theme alias.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The name that you want to give to the theme alias that you are creating. The alias name can't begin with a <code>$</code>. Alias names that start with <code>$</code> are reserved by Amazon QuickSight. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"AliasName"
|
||||
},
|
||||
"ThemeVersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The version number of the theme.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateThemeAliasResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeAlias":{
|
||||
"shape":"ThemeAlias",
|
||||
"documentation":"<p>Information about the theme alias.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateThemeRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId",
|
||||
"Name",
|
||||
"BaseThemeId",
|
||||
"Configuration"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account where you want to store the new theme. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"ThemeName",
|
||||
"documentation":"<p>A display name for the theme.</p>"
|
||||
},
|
||||
"BaseThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use <code>ListThemes</code> or choose <b>Themes</b> from within a QuickSight analysis. </p>"
|
||||
},
|
||||
"VersionDescription":{
|
||||
"shape":"VersionDescription",
|
||||
"documentation":"<p>A description of the first version of the theme that you're creating. Every time <code>UpdateTheme</code> is called, a new version is created. Each version of the theme has a description of the version in the <code>VersionDescription</code> field.</p>"
|
||||
},
|
||||
"Configuration":{
|
||||
"shape":"ThemeConfiguration",
|
||||
"documentation":"<p>The theme configuration, which contains the theme display properties.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"ResourcePermissionList",
|
||||
"documentation":"<p>A valid grouping of resource permissions to apply to the new theme. </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A map of the key-value pairs for the resource tag or tags that you want to add to the resource.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateThemeResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the theme.</p>"
|
||||
},
|
||||
"VersionArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the new theme.</p>"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID of the theme.</p>"
|
||||
},
|
||||
"CreationStatus":{
|
||||
"shape":"ResourceStatus",
|
||||
"documentation":"<p>The theme creation status.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CredentialPair":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2246,6 +2654,10 @@
|
|||
"Password":{
|
||||
"shape":"Password",
|
||||
"documentation":"<p>Password.</p>"
|
||||
},
|
||||
"AlternateDataSourceParameters":{
|
||||
"shape":"DataSourceParametersList",
|
||||
"documentation":"<p>A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the <code>DataSourceParameters</code> structure that's in the request with the structures in the <code>AlternateDataSourceParameters</code> allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the <code>AlternateDataSourceParameters</code> list is null, the <code>DataSourceParameters</code> originally used with these <code>Credentials</code> is automatically allowed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The combination of user name and password that are used as credentials.</p>"
|
||||
|
|
@ -2391,15 +2803,15 @@
|
|||
"members":{
|
||||
"Operator":{
|
||||
"shape":"FilterOperator",
|
||||
"documentation":"<p>The comparison operator that you want to use as a filter. For example, <code>\"Operator\": \"StringEquals\"</code>.</p>"
|
||||
"documentation":"<p>The comparison operator that you want to use as a filter, for example, <code>\"Operator\": \"StringEquals\"</code>.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"DashboardFilterAttribute",
|
||||
"documentation":"<p>The name of the value that you want to use as a filter. For example, <code>\"Name\": \"QUICKSIGHT_USER\"</code>. </p>"
|
||||
"documentation":"<p>The name of the value that you want to use as a filter, for example, <code>\"Name\": \"QUICKSIGHT_USER\"</code>. </p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter. For example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>. </p>"
|
||||
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter, for example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A filter that you apply when searching for dashboards. </p>"
|
||||
|
|
@ -2556,6 +2968,24 @@
|
|||
"member":{"shape":"DashboardVersionSummary"},
|
||||
"max":100
|
||||
},
|
||||
"DataColorPalette":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Colors":{
|
||||
"shape":"ColorList",
|
||||
"documentation":"<p>The hexadecimal codes for the colors.</p>"
|
||||
},
|
||||
"MinMaxGradient":{
|
||||
"shape":"ColorList",
|
||||
"documentation":"<p>The minimum and maximum hexadecimal codes that describe a color gradient. </p>"
|
||||
},
|
||||
"EmptyFillColor":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The hexadecimal code of a color that applies to charts where a lack of data is highlighted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The theme colors that are used for data colors in charts. The colors description is a hexidecimal color code that consists of six alphanumerical characters, prefixed with <code>#</code>, for example #37BFF5. </p>"
|
||||
},
|
||||
"DataSet":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2756,6 +3186,10 @@
|
|||
"shape":"DataSourceParameters",
|
||||
"documentation":"<p>The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
|
||||
},
|
||||
"AlternateDataSourceParameters":{
|
||||
"shape":"DataSourceParametersList",
|
||||
"documentation":"<p>A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the <code>DataSourceParameters</code> structure that's in the request with the structures in the <code>AlternateDataSourceParameters</code> allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the <code>AlternateDataSourceParameters</code> list is null, the <code>Credentials</code> originally used with this <code>DataSourceParameters</code> are automatically allowed.</p>"
|
||||
},
|
||||
"VpcConnectionProperties":{
|
||||
"shape":"VpcConnectionProperties",
|
||||
"documentation":"<p>The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.</p>"
|
||||
|
|
@ -2776,10 +3210,14 @@
|
|||
"members":{
|
||||
"CredentialPair":{
|
||||
"shape":"CredentialPair",
|
||||
"documentation":"<p>Credential pair.</p>"
|
||||
"documentation":"<p>Credential pair. For more information, see <a>CredentialPair</a>.</p>"
|
||||
},
|
||||
"CopySourceArn":{
|
||||
"shape":"CopySourceArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When <code>CopySourceArn</code> is not null, the credential pair from the data source in the ARN is used as the credentials for the <code>DataSourceCredentials</code> structure.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Data source credentials.</p>",
|
||||
"documentation":"<p>Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>",
|
||||
"sensitive":true
|
||||
},
|
||||
"DataSourceErrorInfo":{
|
||||
|
|
@ -2799,6 +3237,8 @@
|
|||
"DataSourceErrorInfoType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ACCESS_DENIED",
|
||||
"COPY_SOURCE_NOT_FOUND",
|
||||
"TIMEOUT",
|
||||
"ENGINE_VERSION_NOT_SUPPORTED",
|
||||
"UNKNOWN_HOST",
|
||||
|
|
@ -2893,6 +3333,12 @@
|
|||
},
|
||||
"documentation":"<p>The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
|
||||
},
|
||||
"DataSourceParametersList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DataSourceParameters"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"DataSourceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -3264,7 +3710,7 @@
|
|||
},
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The name for the template alias. If you name a specific alias, you delete the version that the alias points to. You can specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. </p>",
|
||||
"documentation":"<p>The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"AliasName"
|
||||
}
|
||||
|
|
@ -3288,7 +3734,7 @@
|
|||
},
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the template you want to delete.</p>"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
|
|
@ -3345,6 +3791,109 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DeleteThemeAliasRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId",
|
||||
"AliasName"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme alias to delete.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme that the specified alias is for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The unique name for the theme alias to delete.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AliasName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteThemeAliasResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The name for the theme alias.</p>"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme resource using the deleted alias.</p>"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>An ID for the theme associated with the deletion.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteThemeRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme that you're deleting.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>An ID for the theme that you want to delete.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"VersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The version of the theme that you want to delete. </p> <p> <b>Note:</b> If you don't provide a version number, you're using this call to <code>DeleteTheme</code> to delete all versions of the theme.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"version-number"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteThemeResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>An ID for the theme.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteUserByPrincipalIdRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3980,6 +4529,151 @@
|
|||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeThemeAliasRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId",
|
||||
"AliasName"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme alias that you're describing.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The name of the theme alias that you want to describe.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AliasName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeThemeAliasResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeAlias":{
|
||||
"shape":"ThemeAlias",
|
||||
"documentation":"<p>Information about the theme alias.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeThemePermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme that you're describing.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme that you want to describe permissions for.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeThemePermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>"
|
||||
},
|
||||
"ThemeArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"ResourcePermissionList",
|
||||
"documentation":"<p>A list of resource permissions set on the theme. </p>"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeThemeRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAndAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme that you're describing.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"VersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The version number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the theme is described.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"version-number"
|
||||
},
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"alias-name"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeThemeResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Theme":{
|
||||
"shape":"Theme",
|
||||
"documentation":"<p>The information about the theme that you are describing.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4221,7 +4915,7 @@
|
|||
"members":{
|
||||
"EmbedUrl":{
|
||||
"shape":"EmbeddingUrl",
|
||||
"documentation":"<p>An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an <code>auth_code</code> value that enables a single sign-on session. </p>"
|
||||
"documentation":"<p>A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API provides the URL with an <code>auth_code</code> value that enables one (and only one) sign-on to a user session that is valid for 10 hours. </p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
|
|
@ -4294,6 +4988,21 @@
|
|||
"min":1,
|
||||
"pattern":"[\\u0020-\\u00FF]+"
|
||||
},
|
||||
"GutterStyle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Show":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>This Boolean value controls whether to display a gutter space between sheet tiles. </p>",
|
||||
"box":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The display options for gutter spacing between tiles on a sheet.</p>"
|
||||
},
|
||||
"HexColor":{
|
||||
"type":"string",
|
||||
"pattern":"^#[A-F0-9]{6}$"
|
||||
},
|
||||
"Host":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
|
|
@ -4327,7 +5036,7 @@
|
|||
"documentation":"<p>Assignment status.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An IAM policy assignment.</p>"
|
||||
"documentation":"<p>An AWS Identity and Access Management (IAM) policy assignment.</p>"
|
||||
},
|
||||
"IAMPolicyAssignmentName":{
|
||||
"type":"string",
|
||||
|
|
@ -5377,6 +6086,171 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListThemeAliasesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme aliases that you're listing.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"next-token"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to be returned per request.</p>",
|
||||
"box":true,
|
||||
"location":"querystring",
|
||||
"locationName":"max-result"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListThemeAliasesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeAliasList":{
|
||||
"shape":"ThemeAliasList",
|
||||
"documentation":"<p>A structure containing the list of the theme's aliases.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListThemeVersionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the themes that you're listing.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"next-token"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to be returned per request.</p>",
|
||||
"box":true,
|
||||
"location":"querystring",
|
||||
"locationName":"max-results"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListThemeVersionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeVersionSummaryList":{
|
||||
"shape":"ThemeVersionSummaryList",
|
||||
"documentation":"<p>A structure containing a list of all the versions of the specified theme.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListThemesRequest":{
|
||||
"type":"structure",
|
||||
"required":["AwsAccountId"],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the themes that you're listing.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"next-token"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to be returned per request.</p>",
|
||||
"box":true,
|
||||
"location":"querystring",
|
||||
"locationName":"max-results"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"ThemeType",
|
||||
"documentation":"<p>The type of themes that you want to list. Valid options include the following:</p> <ul> <li> <p> <code>ALL (default)</code>- Display all existing themes.</p> </li> <li> <p> <code>CUSTOM</code> - Display only the themes created by people using Amazon QuickSight.</p> </li> <li> <p> <code>QUICKSIGHT</code> - Display only the starting themes defined by QuickSight.</p> </li> </ul>",
|
||||
"location":"querystring",
|
||||
"locationName":"type"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListThemesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeSummaryList":{
|
||||
"shape":"ThemeSummaryList",
|
||||
"documentation":"<p>Information about the themes in the list.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListUserGroupsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -5573,6 +6447,17 @@
|
|||
},
|
||||
"documentation":"<p>Amazon S3 manifest file location.</p>"
|
||||
},
|
||||
"MarginStyle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Show":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>This Boolean value controls whether to display sheet margins.</p>",
|
||||
"box":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The display options for margins around the outside edge of sheets.</p>"
|
||||
},
|
||||
"MariaDbParameters":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -6016,7 +6901,7 @@
|
|||
"Message":{"shape":"String"},
|
||||
"ResourceType":{
|
||||
"shape":"ExceptionResourceType",
|
||||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||||
"documentation":"<p>The resource type for this request.</p>"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
|
|
@ -6039,7 +6924,7 @@
|
|||
"Message":{"shape":"String"},
|
||||
"ResourceType":{
|
||||
"shape":"ExceptionResourceType",
|
||||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||||
"documentation":"<p>The resource type for this request.</p>"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
|
|
@ -6059,7 +6944,7 @@
|
|||
"members":{
|
||||
"Principal":{
|
||||
"shape":"Principal",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of an Amazon QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the principal. This can be one of the following:</p> <ul> <li> <p>The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)</p> </li> <li> <p>The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.) </p> </li> </ul>"
|
||||
},
|
||||
"Actions":{
|
||||
"shape":"ActionList",
|
||||
|
|
@ -6213,7 +7098,7 @@
|
|||
},
|
||||
"Filters":{
|
||||
"shape":"DashboardSearchFilterList",
|
||||
"documentation":"<p>The filters to apply to the search. Currently, you can search only by user name. For example, <code>\"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]</code> </p>"
|
||||
"documentation":"<p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>\"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]</code> </p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
|
|
@ -6286,6 +7171,20 @@
|
|||
},
|
||||
"documentation":"<p>Sheet controls option.</p>"
|
||||
},
|
||||
"SheetStyle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tile":{
|
||||
"shape":"TileStyle",
|
||||
"documentation":"<p>The display options for tiles.</p>"
|
||||
},
|
||||
"TileLayout":{
|
||||
"shape":"TileLayoutStyle",
|
||||
"documentation":"<p>The layout options for tiles.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The theme display options for sheets. </p>"
|
||||
},
|
||||
"SiteBaseUrl":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
|
|
@ -6749,6 +7648,218 @@
|
|||
"SINGLE_QUOTE"
|
||||
]
|
||||
},
|
||||
"Theme":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"ThemeName",
|
||||
"documentation":"<p>The name that the user gives to the theme.</p>"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The identifier that the user gives to the theme.</p>"
|
||||
},
|
||||
"Version":{"shape":"ThemeVersion"},
|
||||
"CreatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time that the theme was created.</p>"
|
||||
},
|
||||
"LastUpdatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time that the theme was last updated.</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"ThemeType",
|
||||
"documentation":"<p>The type of theme, based on how it was created. Valid values include: <code>QUICKSIGHT</code> and <code>CUSTOM</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"ThemeAlias":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme alias.</p>"
|
||||
},
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The display name of the theme alias.</p>"
|
||||
},
|
||||
"ThemeVersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The version number of the theme alias.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An alias for a theme.</p>"
|
||||
},
|
||||
"ThemeAliasList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ThemeAlias"},
|
||||
"max":100
|
||||
},
|
||||
"ThemeConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DataColorPalette":{
|
||||
"shape":"DataColorPalette",
|
||||
"documentation":"<p>Color properties that apply to chart data colors.</p>"
|
||||
},
|
||||
"UIColorPalette":{
|
||||
"shape":"UIColorPalette",
|
||||
"documentation":"<p>Color properties that apply to the UI and to charts, excluding the colors that apply to data. </p>"
|
||||
},
|
||||
"Sheet":{
|
||||
"shape":"SheetStyle",
|
||||
"documentation":"<p>Display options related to sheets.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The theme configuration. This configuration contains all of the display properties for a theme.</p>"
|
||||
},
|
||||
"ThemeError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Type":{
|
||||
"shape":"ThemeErrorType",
|
||||
"documentation":"<p>The type of error.</p>"
|
||||
},
|
||||
"Message":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The error message.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Theme error.</p>"
|
||||
},
|
||||
"ThemeErrorList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ThemeError"},
|
||||
"min":1
|
||||
},
|
||||
"ThemeErrorType":{
|
||||
"type":"string",
|
||||
"enum":["INTERNAL_FAILURE"]
|
||||
},
|
||||
"ThemeName":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":1
|
||||
},
|
||||
"ThemeSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"ThemeName",
|
||||
"documentation":"<p>the display name for the theme.</p>"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID of the theme. This ID is unique per AWS Region for each AWS account.</p>"
|
||||
},
|
||||
"LatestVersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The latest version number for the theme. </p>"
|
||||
},
|
||||
"CreatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time that this theme was created.</p>"
|
||||
},
|
||||
"LastUpdatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The last date and time that this theme was updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The theme summary.</p>"
|
||||
},
|
||||
"ThemeSummaryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ThemeSummary"},
|
||||
"max":100
|
||||
},
|
||||
"ThemeType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"QUICKSIGHT",
|
||||
"CUSTOM",
|
||||
"ALL"
|
||||
]
|
||||
},
|
||||
"ThemeVersion":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"VersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The version number of the theme.</p>"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"VersionDescription",
|
||||
"documentation":"<p>The description of the theme.</p>"
|
||||
},
|
||||
"BaseThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.</p>"
|
||||
},
|
||||
"CreatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time that this theme version was created.</p>"
|
||||
},
|
||||
"Configuration":{
|
||||
"shape":"ThemeConfiguration",
|
||||
"documentation":"<p>The theme configuration, which contains all the theme display properties.</p>"
|
||||
},
|
||||
"Errors":{
|
||||
"shape":"ThemeErrorList",
|
||||
"documentation":"<p>Errors associated with the theme.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"ResourceStatus",
|
||||
"documentation":"<p>The status of the theme version.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A version of a theme.</p>"
|
||||
},
|
||||
"ThemeVersionSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"VersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The version number of the theme version.</p>"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme version.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"VersionDescription",
|
||||
"documentation":"<p>The description of the theme version.</p>"
|
||||
},
|
||||
"CreatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time that this theme version was created.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"ResourceStatus",
|
||||
"documentation":"<p>The status of the theme version.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The theme version.</p>"
|
||||
},
|
||||
"ThemeVersionSummaryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ThemeVersionSummary"},
|
||||
"max":100
|
||||
},
|
||||
"ThrottlingException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -6762,6 +7873,30 @@
|
|||
"error":{"httpStatusCode":429},
|
||||
"exception":true
|
||||
},
|
||||
"TileLayoutStyle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Gutter":{
|
||||
"shape":"GutterStyle",
|
||||
"documentation":"<p>The gutter settings that apply between tiles. </p>"
|
||||
},
|
||||
"Margin":{
|
||||
"shape":"MarginStyle",
|
||||
"documentation":"<p>The margin settings that apply around the outside edge of sheets.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The display options for the layout of tiles on a sheet.</p>"
|
||||
},
|
||||
"TileStyle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Border":{
|
||||
"shape":"BorderStyle",
|
||||
"documentation":"<p>The border around a tile.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Display options related to tiles on a sheet.</p>"
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"TimestampList":{
|
||||
"type":"list",
|
||||
|
|
@ -6825,6 +7960,76 @@
|
|||
"type":"string",
|
||||
"max":32
|
||||
},
|
||||
"UIColorPalette":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PrimaryForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.</p>"
|
||||
},
|
||||
"PrimaryBackground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The background color that applies to visuals and other high emphasis UI.</p>"
|
||||
},
|
||||
"SecondaryForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.</p>"
|
||||
},
|
||||
"SecondaryBackground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The background color that applies to the sheet background and sheet controls.</p>"
|
||||
},
|
||||
"Accent":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>This color is that applies to selected states and buttons.</p>"
|
||||
},
|
||||
"AccentForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the accent color.</p>"
|
||||
},
|
||||
"Danger":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The color that applies to error messages.</p>"
|
||||
},
|
||||
"DangerForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the error color.</p>"
|
||||
},
|
||||
"Warning":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>This color that applies to warning and informational messages.</p>"
|
||||
},
|
||||
"WarningForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the warning color.</p>"
|
||||
},
|
||||
"Success":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The color that applies to success messages, for example the check mark for a successful download.</p>"
|
||||
},
|
||||
"SuccessForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the success color.</p>"
|
||||
},
|
||||
"Dimension":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The color that applies to the names of fields that are identified as dimensions.</p>"
|
||||
},
|
||||
"DimensionForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the dimension color.</p>"
|
||||
},
|
||||
"Measure":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The color that applies to the names of fields that are identified as measures.</p>"
|
||||
},
|
||||
"MeasureForeground":{
|
||||
"shape":"HexColor",
|
||||
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the measure color.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexidecimal color code that consists of six alphanumerical characters, prefixed with <code>#</code>, for example #37BFF5. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html\">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i> </p>"
|
||||
},
|
||||
"UnsupportedUserEditionException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -7005,11 +8210,11 @@
|
|||
},
|
||||
"SourceEntity":{
|
||||
"shape":"DashboardSourceEntity",
|
||||
"documentation":"<p>The template or analysis from which the dashboard is created. The <code>SouceTemplate</code> entity accepts the Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.</p>"
|
||||
"documentation":"<p>The entity that you are using as a source when you update the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the <a>CreateTemplate</a> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code> ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"Parameters",
|
||||
"documentation":"<p>A structure that contains the parameters of the dashboard.</p>"
|
||||
"documentation":"<p>A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.</p>"
|
||||
},
|
||||
"VersionDescription":{
|
||||
"shape":"VersionDescription",
|
||||
|
|
@ -7017,7 +8222,11 @@
|
|||
},
|
||||
"DashboardPublishOptions":{
|
||||
"shape":"DashboardPublishOptions",
|
||||
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .csv format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. The sheet controls pane is collapsed by default when set to true. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
|
||||
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .csv format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
|
||||
},
|
||||
"ThemeArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -7425,8 +8634,7 @@
|
|||
"UpdateResourcePermissionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourcePermission"},
|
||||
"max":100,
|
||||
"min":1
|
||||
"max":100
|
||||
},
|
||||
"UpdateTemplateAliasRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -7556,7 +8764,7 @@
|
|||
},
|
||||
"SourceEntity":{
|
||||
"shape":"TemplateSourceEntity",
|
||||
"documentation":"<p>The source QuickSight entity from which this template is being updated. You can currently update templates from an Analysis or another template.</p>"
|
||||
"documentation":"<p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
|
||||
},
|
||||
"VersionDescription":{
|
||||
"shape":"VersionDescription",
|
||||
|
|
@ -7598,6 +8806,180 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"UpdateThemeAliasRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId",
|
||||
"AliasName",
|
||||
"ThemeVersionNumber"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme alias that you're updating.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"AliasName":{
|
||||
"shape":"AliasName",
|
||||
"documentation":"<p>The name of the theme alias that you want to update.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AliasName"
|
||||
},
|
||||
"ThemeVersionNumber":{
|
||||
"shape":"VersionNumber",
|
||||
"documentation":"<p>The version number of the theme that the alias should reference.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateThemeAliasResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeAlias":{
|
||||
"shape":"ThemeAlias",
|
||||
"documentation":"<p>Information about the theme alias.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateThemePermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"GrantPermissions":{
|
||||
"shape":"UpdateResourcePermissionList",
|
||||
"documentation":"<p>A list of resource permissions to be granted for the theme.</p>"
|
||||
},
|
||||
"RevokePermissions":{
|
||||
"shape":"UpdateResourcePermissionList",
|
||||
"documentation":"<p>A list of resource permissions to be revoked from the theme.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateThemePermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>"
|
||||
},
|
||||
"ThemeArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
|
||||
},
|
||||
"Permissions":{
|
||||
"shape":"ResourcePermissionList",
|
||||
"documentation":"<p>The resulting list of resource permissions for the theme.</p>"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateThemeRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AwsAccountId",
|
||||
"ThemeId",
|
||||
"BaseThemeId"
|
||||
],
|
||||
"members":{
|
||||
"AwsAccountId":{
|
||||
"shape":"AwsAccountId",
|
||||
"documentation":"<p>The ID of the AWS account that contains the theme that you're updating.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"AwsAccountId"
|
||||
},
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"ThemeId"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"ThemeName",
|
||||
"documentation":"<p>The name for the theme.</p>"
|
||||
},
|
||||
"BaseThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.</p>"
|
||||
},
|
||||
"VersionDescription":{
|
||||
"shape":"VersionDescription",
|
||||
"documentation":"<p>A description of the theme version that you're updating Every time that you call <code>UpdateTheme</code>, you create a new version of the theme. Each version of the theme maintains a description of the version in <code>VersionDescription</code>.</p>"
|
||||
},
|
||||
"Configuration":{
|
||||
"shape":"ThemeConfiguration",
|
||||
"documentation":"<p>The theme configuration, which contains the theme display properties.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateThemeResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ThemeId":{
|
||||
"shape":"RestrictiveResourceId",
|
||||
"documentation":"<p>The ID for the theme.</p>"
|
||||
},
|
||||
"Arn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the theme.</p>"
|
||||
},
|
||||
"VersionArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the new version of the theme.</p>"
|
||||
},
|
||||
"CreationStatus":{
|
||||
"shape":"ResourceStatus",
|
||||
"documentation":"<p>The creation status of the theme.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusCode",
|
||||
"documentation":"<p>The HTTP status of the request.</p>",
|
||||
"location":"statusCode"
|
||||
},
|
||||
"RequestId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateUserRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
|
|||
|
|
@ -451,7 +451,7 @@
|
|||
{"shape":"DBProxyAlreadyExistsFault"},
|
||||
{"shape":"DBProxyQuotaExceededFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Creates a new DB proxy.</p>"
|
||||
"documentation":"<p>Creates a new DB proxy.</p>"
|
||||
},
|
||||
"CreateDBSecurityGroup":{
|
||||
"name":"CreateDBSecurityGroup",
|
||||
|
|
@ -719,7 +719,7 @@
|
|||
{"shape":"DBProxyNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Deletes an existing proxy.</p>"
|
||||
"documentation":"<p>Deletes an existing proxy.</p>"
|
||||
},
|
||||
"DeleteDBSecurityGroup":{
|
||||
"name":"DeleteDBSecurityGroup",
|
||||
|
|
@ -845,7 +845,7 @@
|
|||
{"shape":"DBProxyNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Remove the association between one or more <code>DBProxyTarget</code> data structures and a <code>DBProxyTargetGroup</code>.</p>"
|
||||
"documentation":"<p>Remove the association between one or more <code>DBProxyTarget</code> data structures and a <code>DBProxyTargetGroup</code>.</p>"
|
||||
},
|
||||
"DescribeAccountAttributes":{
|
||||
"name":"DescribeAccountAttributes",
|
||||
|
|
@ -1112,7 +1112,7 @@
|
|||
"errors":[
|
||||
{"shape":"DBProxyNotFoundFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Returns information about DB proxies.</p>"
|
||||
"documentation":"<p>Returns information about DB proxies.</p>"
|
||||
},
|
||||
"DescribeDBProxyTargetGroups":{
|
||||
"name":"DescribeDBProxyTargetGroups",
|
||||
|
|
@ -1130,7 +1130,7 @@
|
|||
{"shape":"DBProxyTargetGroupNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Returns information about DB proxy target groups, represented by <code>DBProxyTargetGroup</code> data structures.</p>"
|
||||
"documentation":"<p>Returns information about DB proxy target groups, represented by <code>DBProxyTargetGroup</code> data structures.</p>"
|
||||
},
|
||||
"DescribeDBProxyTargets":{
|
||||
"name":"DescribeDBProxyTargets",
|
||||
|
|
@ -1149,7 +1149,7 @@
|
|||
{"shape":"DBProxyTargetGroupNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Returns information about <code>DBProxyTarget</code> objects. This API supports pagination.</p>"
|
||||
"documentation":"<p>Returns information about <code>DBProxyTarget</code> objects. This API supports pagination.</p>"
|
||||
},
|
||||
"DescribeDBSecurityGroups":{
|
||||
"name":"DescribeDBSecurityGroups",
|
||||
|
|
@ -1667,7 +1667,9 @@
|
|||
{"shape":"AuthorizationNotFoundFault"},
|
||||
{"shape":"CertificateNotFoundFault"},
|
||||
{"shape":"DomainNotFoundFault"},
|
||||
{"shape":"BackupPolicyNotFoundFault"}
|
||||
{"shape":"BackupPolicyNotFoundFault"},
|
||||
{"shape":"KMSKeyNotAccessibleFault"},
|
||||
{"shape":"InvalidDBClusterStateFault"}
|
||||
],
|
||||
"documentation":"<p>Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call <code>DescribeValidDBInstanceModifications</code> before you call <code>ModifyDBInstance</code>. </p>"
|
||||
},
|
||||
|
|
@ -1704,7 +1706,7 @@
|
|||
{"shape":"DBProxyAlreadyExistsFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Changes the settings for an existing DB proxy.</p>"
|
||||
"documentation":"<p>Changes the settings for an existing DB proxy.</p>"
|
||||
},
|
||||
"ModifyDBProxyTargetGroup":{
|
||||
"name":"ModifyDBProxyTargetGroup",
|
||||
|
|
@ -1722,7 +1724,7 @@
|
|||
{"shape":"DBProxyTargetGroupNotFoundFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Modifies the properties of a <code>DBProxyTargetGroup</code>.</p>"
|
||||
"documentation":"<p>Modifies the properties of a <code>DBProxyTargetGroup</code>.</p>"
|
||||
},
|
||||
"ModifyDBSnapshot":{
|
||||
"name":"ModifyDBSnapshot",
|
||||
|
|
@ -1923,7 +1925,7 @@
|
|||
{"shape":"InvalidDBClusterStateFault"},
|
||||
{"shape":"InvalidDBProxyStateFault"}
|
||||
],
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Associate one or more <code>DBProxyTarget</code> data structures with a <code>DBProxyTargetGroup</code>.</p>"
|
||||
"documentation":"<p>Associate one or more <code>DBProxyTarget</code> data structures with a <code>DBProxyTargetGroup</code>.</p>"
|
||||
},
|
||||
"RemoveFromGlobalCluster":{
|
||||
"name":"RemoveFromGlobalCluster",
|
||||
|
|
@ -2880,10 +2882,10 @@
|
|||
},
|
||||
"InitQuery":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>. </p> <p> <code>InitQuery</code> is not currently supported for PostgreSQL.</p> <p>Default: no initialization query</p>"
|
||||
"documentation":"<p> One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>. </p> <p>Default: no initialization query</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Specifies the settings that control the size and behavior of the connection pool associated with a <code>DBProxyTargetGroup</code>.</p>"
|
||||
"documentation":"<p>Specifies the settings that control the size and behavior of the connection pool associated with a <code>DBProxyTargetGroup</code>.</p>"
|
||||
},
|
||||
"ConnectionPoolConfigurationInfo":{
|
||||
"type":"structure",
|
||||
|
|
@ -2906,10 +2908,10 @@
|
|||
},
|
||||
"InitQuery":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>. </p> <p> <code>InitQuery</code> is not currently supported for PostgreSQL.</p>"
|
||||
"documentation":"<p> One or more SQL statements for the proxy to run when opening each new database connection. Typically used with <code>SET</code> statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single <code>SET</code> statement, such as <code>SET x=1, y=2</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Displays the settings that control the size and behavior of the connection pool associated with a <code>DBProxyTarget</code>.</p>"
|
||||
"documentation":"<p>Displays the settings that control the size and behavior of the connection pool associated with a <code>DBProxyTarget</code>.</p>"
|
||||
},
|
||||
"CopyDBClusterParameterGroupMessage":{
|
||||
"type":"structure",
|
||||
|
|
@ -3663,7 +3665,7 @@
|
|||
},
|
||||
"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> <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>"
|
||||
"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> <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>"
|
||||
},
|
||||
"DomainIAMRoleName":{
|
||||
"shape":"String",
|
||||
|
|
@ -5689,7 +5691,7 @@
|
|||
"documentation":"<p>The date and time when the proxy was last updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>The data structure representing a proxy managed by the RDS Proxy.</p> <p>This data type is used as a response element in the <code>DescribeDBProxies</code> action.</p>"
|
||||
"documentation":"<p>The data structure representing a proxy managed by the RDS Proxy.</p> <p>This data type is used as a response element in the <code>DescribeDBProxies</code> action.</p>"
|
||||
},
|
||||
"DBProxyAlreadyExistsFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -5777,7 +5779,7 @@
|
|||
"documentation":"<p>Information about the connection health of the RDS Proxy target.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.</p> <p>This data type is used as a response element in the <code>DescribeDBProxyTargets</code> action.</p>"
|
||||
"documentation":"<p>Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.</p> <p>This data type is used as a response element in the <code>DescribeDBProxyTargets</code> action.</p>"
|
||||
},
|
||||
"DBProxyTargetAlreadyRegisteredFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -5827,7 +5829,7 @@
|
|||
"documentation":"<p>The date and time when the target group was last updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.</p> <p>This data type is used as a response element in the <code>DescribeDBProxyTargetGroups</code> action.</p>"
|
||||
"documentation":"<p>Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.</p> <p>This data type is used as a response element in the <code>DescribeDBProxyTargetGroups</code> action.</p>"
|
||||
},
|
||||
"DBProxyTargetGroupNotFoundFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -9259,7 +9261,7 @@
|
|||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"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>"
|
||||
"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",
|
||||
|
|
@ -10141,6 +10143,10 @@
|
|||
"SupportsKerberosAuthentication":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p>Whether a DB instance supports Kerberos Authentication.</p>"
|
||||
},
|
||||
"OutpostCapable":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Whether a DB instance supports RDS on Outposts.</p> <p>For more information about RDS on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html\">Amazon RDS on AWS Outposts</a> in the <i>Amazon RDS User Guide.</i> </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>",
|
||||
|
|
@ -10167,6 +10173,16 @@
|
|||
},
|
||||
"documentation":"<p> Contains the result of a successful invocation of the <code>DescribeOrderableDBInstanceOptions</code> action. </p>"
|
||||
},
|
||||
"Outpost":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Arn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Outpost.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A data type that represents an Outpost.</p> <p>For more information about RDS on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html\">Amazon RDS on AWS Outposts</a> in the <i>Amazon RDS User Guide.</i> </p>"
|
||||
},
|
||||
"Parameter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -11391,7 +11407,7 @@
|
|||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"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>"
|
||||
"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",
|
||||
|
|
@ -11717,7 +11733,7 @@
|
|||
},
|
||||
"Domain":{
|
||||
"shape":"String",
|
||||
"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>"
|
||||
"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",
|
||||
|
|
@ -12216,15 +12232,19 @@
|
|||
"members":{
|
||||
"SubnetIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the identifier of the subnet.</p>"
|
||||
"documentation":"<p>The identifier of the subnet.</p>"
|
||||
},
|
||||
"SubnetAvailabilityZone":{"shape":"AvailabilityZone"},
|
||||
"SubnetOutpost":{
|
||||
"shape":"Outpost",
|
||||
"documentation":"<p>If the subnet is associated with an Outpost, this value specifies the Outpost.</p> <p>For more information about RDS on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html\">Amazon RDS on AWS Outposts</a> in the <i>Amazon RDS User Guide.</i> </p>"
|
||||
},
|
||||
"SubnetStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the status of the subnet.</p>"
|
||||
"documentation":"<p>The status of the subnet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> This data type is used as a response element in the <code>DescribeDBSubnetGroups</code> action. </p>"
|
||||
"documentation":"<p> This data type is used as a response element for the <code>DescribeDBSubnetGroups</code> operation. </p>"
|
||||
},
|
||||
"SubnetAlreadyInUse":{
|
||||
"type":"structure",
|
||||
|
|
@ -12355,7 +12375,7 @@
|
|||
"documentation":"<p>A description of the health of the RDS Proxy target. If the <code>State</code> is <code>AVAILABLE</code>, a description is not included.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Information about the connection health of an RDS Proxy target.</p>"
|
||||
"documentation":"<p>Information about the connection health of an RDS Proxy target.</p>"
|
||||
},
|
||||
"TargetHealthReason":{
|
||||
"type":"string",
|
||||
|
|
@ -12446,7 +12466,7 @@
|
|||
"documentation":"<p>Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Specifies the details of authentication used by a proxy to log in as a specific database user.</p>"
|
||||
"documentation":"<p>Specifies the details of authentication used by a proxy to log in as a specific database user.</p>"
|
||||
},
|
||||
"UserAuthConfigInfo":{
|
||||
"type":"structure",
|
||||
|
|
@ -12472,7 +12492,7 @@
|
|||
"documentation":"<p>Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.</p> </note> <p>Returns the details of authentication used by a proxy to log in as a specific database user.</p>"
|
||||
"documentation":"<p>Returns the details of authentication used by a proxy to log in as a specific database user.</p>"
|
||||
},
|
||||
"UserAuthConfigInfoList":{
|
||||
"type":"list",
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -27,7 +27,7 @@
|
|||
{"shape":"InternalServiceError"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.</p> <p>To re-enable scheduled rotation, call <a>RotateSecret</a> with <code>AutomaticallyRotateAfterDays</code> set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.</p> <note> <p>If you cancel a rotation that is in progress, it can leave the <code>VersionStage</code> labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified by the <code>VersionId</code> response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's <code>VersionStage</code> field.</p> </note> <p>To successfully start a rotation, the staging label <code>AWSPENDING</code> must be in one of the following states:</p> <ul> <li> <p>Not be attached to any version at all</p> </li> <li> <p>Attached to the same version as the staging label <code>AWSCURRENT</code> </p> </li> </ul> <p>If the staging label <code>AWSPENDING</code> is attached to a different version than the version with <code>AWSCURRENT</code> then the attempt to rotate fails.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:CancelRotateSecret</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To configure rotation for a secret or to manually trigger a rotation, use <a>RotateSecret</a>.</p> </li> <li> <p>To get the rotation configuration details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> <li> <p>To list all of the versions currently associated with a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress.</p> <p>To re-enable scheduled rotation, call <a>RotateSecret</a> with <code>AutomaticallyRotateAfterDays</code> set to a value greater than 0. This immediately rotates your secret and then enables the automatic schedule.</p> <note> <p>If you cancel a rotation while in progress, it can leave the <code>VersionStage</code> labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified by the <code>VersionId</code> response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version <code>VersionStage</code> field.</p> </note> <p>To successfully start a rotation, the staging label <code>AWSPENDING</code> must be in one of the following states:</p> <ul> <li> <p>Not attached to any version at all</p> </li> <li> <p>Attached to the same version as the staging label <code>AWSCURRENT</code> </p> </li> </ul> <p>If the staging label <code>AWSPENDING</code> attached to a different version than the version with <code>AWSCURRENT</code> then the attempt to rotate fails.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:CancelRotateSecret</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To configure rotation for a secret or to manually trigger a rotation, use <a>RotateSecret</a>.</p> </li> <li> <p>To get the rotation configuration details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> <li> <p>To list all of the versions currently associated with a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
},
|
||||
"CreateSecret":{
|
||||
"name":"CreateSecret",
|
||||
|
|
@ -48,7 +48,7 @@
|
|||
{"shape":"InternalServiceError"},
|
||||
{"shape":"PreconditionNotMetException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.</p> <p>Secrets Manager stores the encrypted secret data in one of a collection of \"versions\" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more \"staging labels\" that identify where the version is in the rotation cycle. The <code>SecretVersionsToStages</code> field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.</p> <p>You provide the secret data to be encrypted by putting text in either the <code>SecretString</code> parameter or binary data in the <code>SecretBinary</code> parameter, but not both. If you include <code>SecretString</code> or <code>SecretBinary</code> then Secrets Manager also creates an initial secret version and automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p> <note> <ul> <li> <p>If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> </p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:CreateSecret</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.</p> </li> <li> <p>kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.</p> </li> <li> <p>secretsmanager:TagResource - needed only if you include the <code>Tags</code> parameter. </p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To delete a secret, use <a>DeleteSecret</a>.</p> </li> <li> <p>To modify an existing secret, use <a>UpdateSecret</a>.</p> </li> <li> <p>To create a new version of a secret, use <a>PutSecretValue</a>.</p> </li> <li> <p>To retrieve the encrypted secure string and secure binary values, use <a>GetSecretValue</a>.</p> </li> <li> <p>To retrieve all other details for a secret, use <a>DescribeSecret</a>. This does not include the encrypted secure string and secure binary values.</p> </li> <li> <p>To retrieve the list of secret versions associated with the current secret, use <a>DescribeSecret</a> and examine the <code>SecretVersionsToStages</code> response value.</p> </li> </ul>"
|
||||
"documentation":"<p>Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.</p> <p>Secrets Manager stores the encrypted secret data in one of a collection of \"versions\" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more \"staging labels\" that identify where the version is in the rotation cycle. The <code>SecretVersionsToStages</code> field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and not included in the list.</p> <p>You provide the secret data to be encrypted by putting text in either the <code>SecretString</code> parameter or binary data in the <code>SecretBinary</code> parameter, but not both. If you include <code>SecretString</code> or <code>SecretBinary</code> then Secrets Manager also creates an initial secret version and automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p> <note> <ul> <li> <p>If you call an operation to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> </p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:CreateSecret</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account default AWS managed CMK for Secrets Manager.</p> </li> <li> <p>kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account default AWS managed CMK for Secrets Manager.</p> </li> <li> <p>secretsmanager:TagResource - needed only if you include the <code>Tags</code> parameter. </p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To delete a secret, use <a>DeleteSecret</a>.</p> </li> <li> <p>To modify an existing secret, use <a>UpdateSecret</a>.</p> </li> <li> <p>To create a new version of a secret, use <a>PutSecretValue</a>.</p> </li> <li> <p>To retrieve the encrypted secure string and secure binary values, use <a>GetSecretValue</a>.</p> </li> <li> <p>To retrieve all other details for a secret, use <a>DescribeSecret</a>. This does not include the encrypted secure string and secure binary values.</p> </li> <li> <p>To retrieve the list of secret versions associated with the current secret, use <a>DescribeSecret</a> and examine the <code>SecretVersionsToStages</code> response value.</p> </li> </ul>"
|
||||
},
|
||||
"DeleteResourcePolicy":{
|
||||
"name":"DeleteResourcePolicy",
|
||||
|
|
@ -63,7 +63,7 @@
|
|||
{"shape":"InternalServiceError"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the resource-based permission policy that's attached to the secret.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DeleteResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p> </li> <li> <p>To retrieve the current resource-based policy that's attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Deletes the resource-based permission policy attached to the secret.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DeleteResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p> </li> <li> <p>To retrieve the current resource-based policy that's attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
},
|
||||
"DeleteSecret":{
|
||||
"name":"DeleteSecret",
|
||||
|
|
@ -93,7 +93,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServiceError"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response. </p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DescribeSecret</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To modify a secret, use <a>UpdateSecret</a>.</p> </li> <li> <p>To retrieve the encrypted secret information in a version of the secret, use <a>GetSecretValue</a>.</p> </li> <li> <p>To list all of the secrets in the AWS account, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields populated with a value in the response. </p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DescribeSecret</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To modify a secret, use <a>UpdateSecret</a>.</p> </li> <li> <p>To retrieve the encrypted secret information in a version of the secret, use <a>GetSecretValue</a>.</p> </li> <li> <p>To list all of the secrets in the AWS account, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
},
|
||||
"GetRandomPassword":{
|
||||
"name":"GetRandomPassword",
|
||||
|
|
@ -123,7 +123,7 @@
|
|||
{"shape":"InternalServiceError"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the JSON text of the resource-based policy document that's attached to the specified secret. The JSON request string input and response output are shown formatted with white space and line breaks for better readability. Submit your input as a single line JSON string.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:GetResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p> </li> <li> <p>To delete the resource-based policy that's attached to a secret, use <a>DeleteResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:GetResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p> </li> <li> <p>To delete the resource-based policy attached to a secret, use <a>DeleteResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
},
|
||||
"GetSecretValue":{
|
||||
"name":"GetSecretValue",
|
||||
|
|
@ -155,7 +155,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServiceError"}
|
||||
],
|
||||
"documentation":"<p>Lists all of the versions attached to the specified secret. The output does not include the <code>SecretString</code> or <code>SecretBinary</code> fields. By default, the list includes only versions that have at least one staging label in <code>VersionStage</code> attached.</p> <note> <p>Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the <code>NextToken</code> response parameter contains a value to pass to the next call to the same API to request the next part of the list.</p> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:ListSecretVersionIds</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To list the secrets in an account, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Lists all of the versions attached to the specified secret. The output does not include the <code>SecretString</code> or <code>SecretBinary</code> fields. By default, the list includes only versions that have at least one staging label in <code>VersionStage</code> attached.</p> <note> <p>Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the <code>NextToken</code> response parameter contains a value to pass to the next call to the same API to request the next part of the list.</p> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:ListSecretVersionIds</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To list the secrets in an account, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
},
|
||||
"ListSecrets":{
|
||||
"name":"ListSecrets",
|
||||
|
|
@ -170,7 +170,7 @@
|
|||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InternalServiceError"}
|
||||
],
|
||||
"documentation":"<p>Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use <a>ListSecretVersionIds</a>. The encrypted fields <code>SecretString</code> and <code>SecretBinary</code> are not included in the output. To get that information, call the <a>GetSecretValue</a> operation.</p> <note> <p>Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the <code>NextToken</code> response parameter contains a value to pass to the next call to the same API to request the next part of the list.</p> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:ListSecrets</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use <a>ListSecretVersionIds</a>. The encrypted fields <code>SecretString</code> and <code>SecretBinary</code> are not included in the output. To get that information, call the <a>GetSecretValue</a> operation.</p> <note> <p>Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the <code>NextToken</code> response parameter contains a value to pass to the next call to the same API to request the next part of the list.</p> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:ListSecrets</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
},
|
||||
"PutResourcePolicy":{
|
||||
"name":"PutResourcePolicy",
|
||||
|
|
@ -185,9 +185,10 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InternalServiceError"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"PublicPolicyException"}
|
||||
],
|
||||
"documentation":"<p>Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's <code>Resources</code> element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see <a href=\"http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html\">Using Resource-Based Policies for AWS Secrets Manager</a>. For the complete description of the AWS policy syntax and grammar, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html\">IAM JSON Policy Reference</a> in the <i>IAM User Guide</i>.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the resource policy that's attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To delete the resource-based policy that's attached to a secret, use <a>DeleteResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's <code>Resources</code> element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see <a href=\"http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html\">Using Resource-Based Policies for AWS Secrets Manager</a>. For the complete description of the AWS policy syntax and grammar, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html\">IAM JSON Policy Reference</a> in the <i>IAM User Guide</i>.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the resource policy attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To delete the resource-based policy that's attached to a secret, use <a>DeleteResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
|
||||
},
|
||||
"PutSecretValue":{
|
||||
"name":"PutSecretValue",
|
||||
|
|
@ -206,7 +207,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServiceError"}
|
||||
],
|
||||
"documentation":"<p>Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also specify the staging labels that are initially attached to the new version.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a secret with the <code>SecretBinary</code> field you must use the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p> </li> <li> <p>If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the <code>VersionStages</code> parameter.</p> </li> <li> <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this version (because you included it in the <code>StagingLabels</code> parameter) then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p> </li> <li> <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.</p> </li> </ul> <note> <ul> <li> <p>If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutSecretValue</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the encrypted value you store in the version of a secret, use <a>GetSecretValue</a>.</p> </li> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also specify the staging labels that are initially attached to the new version.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a secret with the <code>SecretBinary</code> field you must use the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p> </li> <li> <p>If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the <code>VersionStages</code> parameter.</p> </li> <li> <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this version (because you included it in the <code>StagingLabels</code> parameter) then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p> </li> <li> <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.</p> </li> </ul> <note> <ul> <li> <p>If you call an operation to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutSecretValue</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the encrypted value you store in the version of a secret, use <a>GetSecretValue</a>.</p> </li> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
},
|
||||
"RestoreSecret":{
|
||||
"name":"RestoreSecret",
|
||||
|
|
@ -238,7 +239,7 @@
|
|||
{"shape":"InternalServiceError"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret. </p> <p>This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label <code>AWSCURRENT</code> so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html\">Rotating Secrets in AWS Secrets Manager</a> in the <i>AWS Secrets Manager User Guide</i>.</p> <p>Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.</p> <p>The rotation function must end with the versions of the secret in one of two states:</p> <ul> <li> <p>The <code>AWSPENDING</code> and <code>AWSCURRENT</code> staging labels are attached to the same version of the secret, or</p> </li> <li> <p>The <code>AWSPENDING</code> staging label is not attached to any version of the secret.</p> </li> </ul> <p>If instead the <code>AWSPENDING</code> staging label is present but is not attached to the same version as <code>AWSCURRENT</code> then any later invocation of <code>RotateSecret</code> assumes that a previous rotation request is still in progress and returns an error.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:RotateSecret</p> </li> <li> <p>lambda:InvokeFunction (on the function specified in the secret's metadata)</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To list the secrets in your account, use <a>ListSecrets</a>.</p> </li> <li> <p>To get the details for a version of a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To create a new version of a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To attach staging labels to or remove staging labels from a version of a secret, use <a>UpdateSecretVersionStage</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret. </p> <p>This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label <code>AWSCURRENT</code> so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html\">Rotating Secrets in AWS Secrets Manager</a> in the <i>AWS Secrets Manager User Guide</i>.</p> <p>Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.</p> <p>The rotation function must end with the versions of the secret in one of two states:</p> <ul> <li> <p>The <code>AWSPENDING</code> and <code>AWSCURRENT</code> staging labels are attached to the same version of the secret, or</p> </li> <li> <p>The <code>AWSPENDING</code> staging label is not attached to any version of the secret.</p> </li> </ul> <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as <code>AWSCURRENT</code> then any later invocation of <code>RotateSecret</code> assumes that a previous rotation request is still in progress and returns an error.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:RotateSecret</p> </li> <li> <p>lambda:InvokeFunction (on the function specified in the secret's metadata)</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To list the secrets in your account, use <a>ListSecrets</a>.</p> </li> <li> <p>To get the details for a version of a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To create a new version of a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To attach staging labels to or remove staging labels from a version of a secret, use <a>UpdateSecretVersionStage</a>.</p> </li> </ul>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -253,7 +254,7 @@
|
|||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InternalServiceError"}
|
||||
],
|
||||
"documentation":"<p>Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use <a>UntagResource</a>.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per secret—50</p> </li> <li> <p>Maximum key length—127 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length—255 Unicode characters in UTF-8</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use the <code>aws:</code> prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.</p> </li> <li> <p>If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.</p> </li> </ul> <important> <p>If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.</p> </important> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:TagResource</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To remove one or more tags from the collection attached to a secret, use <a>UntagResource</a>.</p> </li> <li> <p>To view the list of tags attached to a secret, use <a>DescribeSecret</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use <a>UntagResource</a>.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per secret—50</p> </li> <li> <p>Maximum key length—127 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length—255 Unicode characters in UTF-8</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use the <code>aws:</code> prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.</p> </li> <li> <p>If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.</p> </li> </ul> <important> <p>If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.</p> </important> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:TagResource</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To remove one or more tags from the collection attached to a secret, use <a>UntagResource</a>.</p> </li> <li> <p>To view the list of tags attached to a secret, use <a>DescribeSecret</a>.</p> </li> </ul>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
|
|
@ -289,7 +290,7 @@
|
|||
{"shape":"InternalServiceError"},
|
||||
{"shape":"PreconditionNotMetException"}
|
||||
],
|
||||
"documentation":"<p>Modifies many of the details of the specified secret. If you include a <code>ClientRequestToken</code> and <i>either</i> <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version attached to the secret.</p> <p>To modify the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If a version with a <code>VersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.</p> </li> <li> <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version. </p> </li> </ul> <note> <ul> <li> <p>If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:UpdateSecret</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> <li> <p>kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a new secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To add only a new version to an existing secret, use <a>PutSecretValue</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions contained in a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
"documentation":"<p>Modifies many of the details of the specified secret. If you include a <code>ClientRequestToken</code> and <i>either</i> <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version attached to the secret.</p> <p>To modify the rotation configuration of a secret, use <a>RotateSecret</a> instead.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If a version with a <code>VersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.</p> </li> <li> <p>If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version. </p> </li> </ul> <note> <ul> <li> <p>If you call an operation to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:UpdateSecret</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> <li> <p>kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a new secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To add only a new version to an existing secret, use <a>PutSecretValue</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions contained in a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
|
||||
},
|
||||
"UpdateSecretVersionStage":{
|
||||
"name":"UpdateSecretVersionStage",
|
||||
|
|
@ -307,6 +308,23 @@
|
|||
{"shape":"InternalServiceError"}
|
||||
],
|
||||
"documentation":"<p>Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label\">Staging Labels</a> in the <i>AWS Secrets Manager User Guide</i>. </p> <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added to the existing list of staging labels--they don't replace it.</p> <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this call.</p> <note> <p>Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p> </note> <p>If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:UpdateSecretVersionStage</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To get the list of staging labels that are currently associated with a version of a secret, use <code> <a>DescribeSecret</a> </code> and examine the <code>SecretVersionsToStages</code> response value. </p> </li> </ul>"
|
||||
},
|
||||
"ValidateResourcePolicy":{
|
||||
"name":"ValidateResourcePolicy",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ValidateResourcePolicyRequest"},
|
||||
"output":{"shape":"ValidateResourcePolicyResponse"},
|
||||
"errors":[
|
||||
{"shape":"MalformedPolicyDocumentException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InternalServiceError"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Validates the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string. A resource-based policy is optional.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -322,7 +340,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -339,7 +357,7 @@
|
|||
},
|
||||
"VersionId":{
|
||||
"shape":"SecretVersionIdType",
|
||||
"documentation":"<p>The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the <code>VersionStage</code> value <code>AWSPENDING</code> to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.</p>"
|
||||
"documentation":"<p>The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the <code>VersionStage</code> value <code>AWSPENDING</code> to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -354,11 +372,11 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameType",
|
||||
"documentation":"<p>Specifies the friendly name of the new secret.</p> <p>The secret name must be ASCII letters, digits, or the following characters : /_+=.@-</p> <note> <p>Don't end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. This is because Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.</p> </note>"
|
||||
"documentation":"<p>Specifies the friendly name of the new secret.</p> <p>The secret name must be ASCII letters, digits, or the following characters : /_+=.@-</p> <note> <p>Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.</p> </note>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestTokenType",
|
||||
"documentation":"<p>(Optional) If you include <code>SecretString</code> or <code>SecretBinary</code>, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. </p> <note> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for the new version and include that value in the request.</p> </note> <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p> <ul> <li> <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created. </p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> and <code>SecretBinary</code> values are the same as those in the request, then the request is ignored (the operation is idempotent).</p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use <a>PutSecretValue</a> to create a new version.</p> </li> </ul> <p>This value becomes the <code>VersionId</code> of the new version.</p>",
|
||||
"documentation":"<p>(Optional) If you include <code>SecretString</code> or <code>SecretBinary</code>, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. </p> <note> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for the new version and include the value in the request.</p> </note> <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p> <ul> <li> <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created. </p> </li> <li> <p>If a version with this value already exists and the version <code>SecretString</code> and <code>SecretBinary</code> values are the same as those in the request, then the request is ignored.</p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use <a>PutSecretValue</a> to create a new version.</p> </li> </ul> <p>This value becomes the <code>VersionId</code> of the new version.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"Description":{
|
||||
|
|
@ -367,7 +385,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"KmsKeyIdType",
|
||||
"documentation":"<p>(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the <code>SecretString</code> or <code>SecretBinary</code> values in the versions stored in this secret.</p> <p>You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.</p> <p>If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named <code>aws/secretsmanager</code>). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's <code>SecretString</code> or <code>SecretBinary</code> fields.</p> <important> <p>You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field. </p> </important>"
|
||||
"documentation":"<p>(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the <code>SecretString</code> or <code>SecretBinary</code> values in the versions stored in this secret.</p> <p>You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.</p> <p>If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named <code>aws/secretsmanager</code>). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's <code>SecretString</code> or <code>SecretBinary</code> fields.</p> <important> <p>You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field. </p> </important>"
|
||||
},
|
||||
"SecretBinary":{
|
||||
"shape":"SecretBinaryType",
|
||||
|
|
@ -375,11 +393,11 @@
|
|||
},
|
||||
"SecretString":{
|
||||
"shape":"SecretStringType",
|
||||
"documentation":"<p>(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.</p> <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not both. They cannot both be empty.</p> <p>If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.</p> <p>For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For example:</p> <p> <code>[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]</code> </p> <p>If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. </p>"
|
||||
"documentation":"<p>(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.</p> <p>Either <code>SecretString</code> or <code>SecretBinary</code> must have a value, but not both. They cannot both be empty.</p> <p>If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the <code>SecretString</code> parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.</p> <p>For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For example:</p> <p> <code>{\"username\":\"bob\",\"password\":\"abc123xyz456\"}</code> </p> <p>If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagListType",
|
||||
"documentation":"<p>(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use <a>UntagResource</a>.</p> <important> <ul> <li> <p>Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".</p> </li> <li> <p>If you check tags in IAM policy <code>Condition</code> elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an <code>Access Denied</code> error.</p> </li> </ul> </important> <p>This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For example:</p> <p> <code>[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]</code> </p> <p>If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. </p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per secret—50</p> </li> <li> <p>Maximum key length—127 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length—255 Unicode characters in UTF-8</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use the <code>aws:</code> prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.</p> </li> <li> <p>If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.</p> </li> </ul>"
|
||||
"documentation":"<p>(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use <a>UntagResource</a>.</p> <important> <ul> <li> <p>Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".</p> </li> <li> <p>If you check tags in IAM policy <code>Condition</code> elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an <code>Access Denied</code> error.</p> </li> </ul> </important> <p>This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For example:</p> <p> <code>[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]</code> </p> <p>If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. </p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per secret—50</p> </li> <li> <p>Maximum key length—127 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length—255 Unicode characters in UTF-8</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use the <code>aws:</code> prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.</p> </li> <li> <p>If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -396,7 +414,7 @@
|
|||
},
|
||||
"VersionId":{
|
||||
"shape":"SecretVersionIdType",
|
||||
"documentation":"<p>The unique identifier that's associated with the version of the secret you just created.</p>"
|
||||
"documentation":"<p>The unique identifier associated with the version of the secret you just created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -415,7 +433,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -438,7 +456,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"RecoveryWindowInDays":{
|
||||
"shape":"RecoveryWindowInDaysType",
|
||||
|
|
@ -478,7 +496,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -545,6 +563,11 @@
|
|||
"OwningService":{
|
||||
"shape":"OwningServiceType",
|
||||
"documentation":"<p>Returns the name of the service that created this secret.</p>"
|
||||
},
|
||||
"CreatedDate":{
|
||||
"shape":"TimestampType",
|
||||
"documentation":"<p>The date that the secret was created.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -570,6 +593,47 @@
|
|||
"ExcludeNumbersType":{"type":"boolean"},
|
||||
"ExcludePunctuationType":{"type":"boolean"},
|
||||
"ExcludeUppercaseType":{"type":"boolean"},
|
||||
"Filter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"FilterNameStringType",
|
||||
"documentation":"<p>Filters your list of secrets by a specific key.</p>"
|
||||
},
|
||||
"Values":{
|
||||
"shape":"FilterValuesStringList",
|
||||
"documentation":"<p>Filters your list of secrets by a specific value.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Allows you to filter your list of secrets.</p>"
|
||||
},
|
||||
"FilterNameStringType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"description",
|
||||
"name",
|
||||
"tag-key",
|
||||
"tag-value",
|
||||
"all"
|
||||
]
|
||||
},
|
||||
"FilterValueStringType":{
|
||||
"type":"string",
|
||||
"max":512,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z0-9 :_@\\/\\+\\=\\.\\-]+"
|
||||
},
|
||||
"FilterValuesStringList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FilterValueStringType"},
|
||||
"max":10,
|
||||
"min":1
|
||||
},
|
||||
"FiltersListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Filter"},
|
||||
"max":10
|
||||
},
|
||||
"GetRandomPasswordRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -629,7 +693,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -656,7 +720,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"VersionId":{
|
||||
"shape":"SecretVersionIdType",
|
||||
|
|
@ -758,16 +822,16 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResultsType",
|
||||
"documentation":"<p>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p>",
|
||||
"documentation":"<p>(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p>",
|
||||
"box":true
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextTokenType",
|
||||
"documentation":"<p>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</p>"
|
||||
"documentation":"<p>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call <code>NextToken</code> response to indicate where the output should continue from.</p>"
|
||||
},
|
||||
"IncludeDeprecated":{
|
||||
"shape":"BooleanType",
|
||||
|
|
@ -785,7 +849,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextTokenType",
|
||||
"documentation":"<p>If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back empty (as <code>null</code>).</p>"
|
||||
"documentation":"<p>If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back empty (as <code>null</code>).</p>"
|
||||
},
|
||||
"ARN":{
|
||||
"shape":"SecretARNType",
|
||||
|
|
@ -802,12 +866,20 @@
|
|||
"members":{
|
||||
"MaxResults":{
|
||||
"shape":"MaxResultsType",
|
||||
"documentation":"<p>(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p>",
|
||||
"documentation":"<p>(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (isn't null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p>",
|
||||
"box":true
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextTokenType",
|
||||
"documentation":"<p>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from.</p>"
|
||||
"documentation":"<p>(Optional) Use this parameter in a request if you receive a <code>NextToken</code> response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call <code>NextToken</code> response to indicate where the output should continue from.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"FiltersListType",
|
||||
"documentation":"<p>Lists the secret request filters.</p>"
|
||||
},
|
||||
"SortOrder":{
|
||||
"shape":"SortOrderType",
|
||||
"documentation":"<p>Lists secrets in the requested order. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -820,7 +892,7 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextTokenType",
|
||||
"documentation":"<p>If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back empty (as <code>null</code>).</p>"
|
||||
"documentation":"<p>If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back empty (as <code>null</code>).</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -870,6 +942,14 @@
|
|||
"documentation":"<p>The request failed because you did not complete all the prerequisite steps.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"PublicPolicyException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>The resource policy did not prevent broad access to the secret.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"PutResourcePolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -879,11 +959,16 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"ResourcePolicy":{
|
||||
"shape":"NonEmptyResourcePolicyType",
|
||||
"documentation":"<p>A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>.</p>"
|
||||
},
|
||||
"BlockPublicPolicy":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -892,11 +977,11 @@
|
|||
"members":{
|
||||
"ARN":{
|
||||
"shape":"SecretARNType",
|
||||
"documentation":"<p>The ARN of the secret that the resource-based policy was retrieved for.</p>"
|
||||
"documentation":"<p>The ARN of the secret retrieved by the resource-based policy.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"NameType",
|
||||
"documentation":"<p>The friendly name of the secret that the resource-based policy was retrieved for.</p>"
|
||||
"documentation":"<p>The friendly name of the secret that the retrieved by the resource-based policy.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -906,11 +991,11 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestTokenType",
|
||||
"documentation":"<p>(Optional) Specifies a unique identifier for the new version of the secret. </p> <note> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for new versions and include that value in the request. </p> </note> <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness within the specified secret. </p> <ul> <li> <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created. </p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in the request then the request is ignored (the operation is idempotent). </p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.</p> </li> </ul> <p>This value becomes the <code>VersionId</code> of the new version.</p>",
|
||||
"documentation":"<p>(Optional) Specifies a unique identifier for the new version of the secret. </p> <note> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for new versions and include that value in the request. </p> </note> <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness within the specified secret. </p> <ul> <li> <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created. </p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in the request then the request is ignored (the operation is idempotent). </p> </li> <li> <p>If a version with this value already exists and the version of the <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.</p> </li> </ul> <p>This value becomes the <code>VersionId</code> of the new version.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"SecretBinary":{
|
||||
|
|
@ -978,7 +1063,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1001,11 +1086,11 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestTokenType",
|
||||
"documentation":"<p>(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency. </p> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for new versions and include that value in the request.</p> <p>You only need to specify your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness within the specified secret. </p> <p>Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the <code>VersionId</code> of the new version.</p>",
|
||||
"documentation":"<p>(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency. </p> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for new versions and include that value in the request.</p> <p>You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness within the specified secret. </p> <p>Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the <code>VersionId</code> of the new version.</p>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"RotationLambdaARN":{
|
||||
|
|
@ -1086,7 +1171,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"KmsKeyIdType",
|
||||
"documentation":"<p>The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the <code>SecretString</code> and <code>SecretBinary</code> fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named <code>awssecretsmanager</code>) for this account.</p>"
|
||||
"documentation":"<p>The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the <code>SecretString</code> and <code>SecretBinary</code> fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named <code>awssecretsmanager</code>, for this account.</p>"
|
||||
},
|
||||
"RotationEnabled":{
|
||||
"shape":"RotationEnabledType",
|
||||
|
|
@ -1095,7 +1180,7 @@
|
|||
},
|
||||
"RotationLambdaARN":{
|
||||
"shape":"RotationLambdaARNType",
|
||||
"documentation":"<p>The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to <a>RotateSecret</a>.</p>"
|
||||
"documentation":"<p>The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to <a>RotateSecret</a>.</p>"
|
||||
},
|
||||
"RotationRules":{
|
||||
"shape":"RotationRulesType",
|
||||
|
|
@ -1118,19 +1203,24 @@
|
|||
},
|
||||
"DeletedDate":{
|
||||
"shape":"DeletedDateType",
|
||||
"documentation":"<p>The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the <code>RecoveryWindowInDays</code> parameter of the <a>DeleteSecret</a> operation.</p>"
|
||||
"documentation":"<p>The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the <code>RecoveryWindowInDays</code> parameter of the <a>DeleteSecret</a> operation.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagListType",
|
||||
"documentation":"<p>The list of user-defined tags that are associated with the secret. To add tags to a secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>"
|
||||
"documentation":"<p>The list of user-defined tags associated with the secret. To add tags to a secret, use <a>TagResource</a>. To remove tags, use <a>UntagResource</a>.</p>"
|
||||
},
|
||||
"SecretVersionsToStages":{
|
||||
"shape":"SecretVersionsToStagesMapType",
|
||||
"documentation":"<p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and the <code>SecretVersionId</code> that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.</p> <note> <p>A version that does not have any <code>SecretVersionStage</code> is considered deprecated and subject to deletion. Such versions are not included in this list.</p> </note>"
|
||||
"documentation":"<p>A list of all of the currently assigned <code>SecretVersionStage</code> staging labels and the <code>SecretVersionId</code> attached to each one. Staging labels are used to keep track of the different versions during the rotation process.</p> <note> <p>A version that does not have any <code>SecretVersionStage</code> is considered deprecated and subject to deletion. Such versions are not included in this list.</p> </note>"
|
||||
},
|
||||
"OwningService":{
|
||||
"shape":"OwningServiceType",
|
||||
"documentation":"<p>Returns the name of the service that created the secret.</p>"
|
||||
},
|
||||
"CreatedDate":{
|
||||
"shape":"TimestampType",
|
||||
"documentation":"<p>The date and time when a secret was created.</p>",
|
||||
"box":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure that contains the details about a secret. It does not include the encrypted <code>SecretString</code> and <code>SecretBinary</code> values. To get those values, use the <a>GetSecretValue</a> operation.</p>"
|
||||
|
|
@ -1199,6 +1289,13 @@
|
|||
"key":{"shape":"SecretVersionIdType"},
|
||||
"value":{"shape":"SecretVersionStagesType"}
|
||||
},
|
||||
"SortOrderType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"asc",
|
||||
"desc"
|
||||
]
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1208,7 +1305,7 @@
|
|||
},
|
||||
"Value":{
|
||||
"shape":"TagValueType",
|
||||
"documentation":"<p>The string value that's associated with the key of the tag.</p>"
|
||||
"documentation":"<p>The string value associated with the key of the tag.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure that contains information about a tag.</p>"
|
||||
|
|
@ -1235,7 +1332,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagListType",
|
||||
|
|
@ -1248,6 +1345,7 @@
|
|||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"TimestampType":{"type":"timestamp"},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1257,7 +1355,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"TagKeyListType",
|
||||
|
|
@ -1271,7 +1369,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestTokenType",
|
||||
|
|
@ -1322,7 +1420,7 @@
|
|||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p>Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.</p> </note>"
|
||||
"documentation":"<p>Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"VersionStage":{
|
||||
"shape":"SecretVersionStageType",
|
||||
|
|
@ -1335,7 +1433,7 @@
|
|||
},
|
||||
"MoveToVersionId":{
|
||||
"shape":"SecretVersionIdType",
|
||||
"documentation":"<p>(Optional) The secret version ID that you want to add the staging label to. If you want to remove a label from a version, then do not specify this parameter.</p> <p>If the staging label is already attached to a different version of the secret, then you must also specify the <code>RemoveFromVersionId</code> parameter. </p>",
|
||||
"documentation":"<p>(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.</p> <p>If the staging label is already attached to a different version of the secret, then you must also specify the <code>RemoveFromVersionId</code> parameter. </p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
|
|
@ -1345,14 +1443,59 @@
|
|||
"members":{
|
||||
"ARN":{
|
||||
"shape":"SecretARNType",
|
||||
"documentation":"<p>The ARN of the secret with the staging label that was modified.</p>"
|
||||
"documentation":"<p>The ARN of the secret with the modified staging label.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"SecretNameType",
|
||||
"documentation":"<p>The friendly name of the secret with the staging label that was modified.</p>"
|
||||
"documentation":"<p>The friendly name of the secret with the modified staging label.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ValidateResourcePolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourcePolicy"],
|
||||
"members":{
|
||||
"SecretId":{
|
||||
"shape":"SecretIdType",
|
||||
"documentation":"<p> The identifier for the secret that you want to validate a resource policy. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
|
||||
},
|
||||
"ResourcePolicy":{
|
||||
"shape":"NonEmptyResourcePolicyType",
|
||||
"documentation":"<p>Identifies the Resource Policy attached to the secret.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ValidateResourcePolicyResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PolicyValidationPassed":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Returns a message stating that your Reource Policy passed validation. </p>"
|
||||
},
|
||||
"ValidationErrors":{
|
||||
"shape":"ValidationErrorsType",
|
||||
"documentation":"<p>Returns an error message if your policy doesn't pass validatation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ValidationErrorsEntry":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CheckName":{
|
||||
"shape":"NameType",
|
||||
"documentation":"<p>Checks the name of the policy.</p>"
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"shape":"ErrorMessage",
|
||||
"documentation":"<p>Displays error messages if validation encounters problems during validation of the resource policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Displays errors that occurred during validation of the resource policy.</p>"
|
||||
},
|
||||
"ValidationErrorsType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ValidationErrorsEntry"}
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS Secrets Manager API Reference</fullname> <p>AWS Secrets Manager is a web service that enables you to store, manage, and retrieve, secrets.</p> <p>This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html\">AWS Secrets Manager User Guide</a>.</p> <p> <b>API Version</b> </p> <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p> <note> <p>As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (such as Java, Ruby, .NET, iOS, and Android). The SDKs provide a convenient way to create programmatic access to AWS Secrets Manager. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note> <p>We recommend that you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/query-requests.html\">Making Query Requests</a> in the <i>AWS Secrets Manager User Guide</i>. </p> <p>Secrets Manager supports GET and POST requests for all actions. That is, the API doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.</p> <p> <b>Support and Feedback for AWS Secrets Manager</b> </p> <p>We welcome your feedback. Send your comments to <a href=\"mailto:awssecretsmanager-feedback@amazon.com\">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href=\"http://forums.aws.amazon.com/forum.jspa?forumID=296\">AWS Secrets Manager Discussion Forum</a>. For more information about the AWS Discussion Forums, see <a href=\"http://forums.aws.amazon.com/help.jspa\">Forums Help</a>.</p> <p> <b>How examples are presented</b> </p> <p>The JSON that AWS Secrets Manager expects as your request parameters and that the service returns as a response to HTTP query requests are single, long strings without line breaks or white space formatting. The JSON shown in the examples is formatted with both line breaks and white space to improve readability. When example input parameters would also result in long strings that extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.</p> <p> <b>Logging API Requests</b> </p> <p>AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine which requests were successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and its support for AWS CloudTrail, see <a href=\"http://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail\">Logging AWS Secrets Manager Events with AWS CloudTrail</a> in the <i>AWS Secrets Manager User Guide</i>. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html\">AWS CloudTrail User Guide</a>.</p>"
|
||||
"documentation":"<fullname>AWS Secrets Manager API Reference</fullname> <p>AWS Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.</p> <p>This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/introduction.html\">AWS Secrets Manager User Guide</a>.</p> <p> <b>API Version</b> </p> <p>This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.</p> <note> <p>As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including downloading and installing them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note> <p>We recommend you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/query-requests.html\">Making Query Requests</a> in the <i>AWS Secrets Manager User Guide</i>. </p> <p>Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.</p> <p> <b>Support and Feedback for AWS Secrets Manager</b> </p> <p>We welcome your feedback. Send your comments to <a href=\"mailto:awssecretsmanager-feedback@amazon.com\">awssecretsmanager-feedback@amazon.com</a>, or post your feedback and questions in the <a href=\"http://forums.aws.amazon.com/forum.jspa?forumID=296\">AWS Secrets Manager Discussion Forum</a>. For more information about the AWS Discussion Forums, see <a href=\"http://forums.aws.amazon.com/help.jspa\">Forums Help</a>.</p> <p> <b>How examples are presented</b> </p> <p>The JSON that AWS Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.</p> <p> <b>Logging API Requests</b> </p> <p>AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and support for AWS CloudTrail, see <a href=\"http://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail\">Logging AWS Secrets Manager Events with AWS CloudTrail</a> in the <i>AWS Secrets Manager User Guide</i>. To learn more about CloudTrail, including enabling it and find your log files, see the <a href=\"https://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html\">AWS CloudTrail User Guide</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -806,6 +806,32 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"AvailabilityZone"}
|
||||
},
|
||||
"AwsAutoScalingAutoScalingGroupDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LaunchConfigurationName":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The name of the launch configuration.</p>"
|
||||
},
|
||||
"LoadBalancerNames":{
|
||||
"shape":"StringList",
|
||||
"documentation":"<p>The list of load balancers associated with the group.</p>"
|
||||
},
|
||||
"HealthCheckType":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The service to use for the health checks.</p>"
|
||||
},
|
||||
"HealthCheckGracePeriod":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.</p>"
|
||||
},
|
||||
"CreatedTime":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The datetime when the auto scaling group was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides details about an auto scaling group.</p>"
|
||||
},
|
||||
"AwsCloudFrontDistributionDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1260,6 +1286,88 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"AwsEc2SecurityGroupUserIdGroupPair"}
|
||||
},
|
||||
"AwsEc2VolumeAttachment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AttachTime":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The datetime when the attachment initiated.</p>"
|
||||
},
|
||||
"DeleteOnTermination":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Whether the EBS volume is deleted when the EC2 instance is terminated.</p>"
|
||||
},
|
||||
"InstanceId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The identifier of the EC2 instance.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The attachment state of the volume.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An attachment to an AWS EC2 volume.</p>"
|
||||
},
|
||||
"AwsEc2VolumeAttachmentList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AwsEc2VolumeAttachment"}
|
||||
},
|
||||
"AwsEc2VolumeDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CreateTime":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The datetime when the volume was created.</p>"
|
||||
},
|
||||
"Encrypted":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Whether the volume is encrypted.</p>"
|
||||
},
|
||||
"Size":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The size of the volume, in GiBs.</p>"
|
||||
},
|
||||
"SnapshotId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The snapshot from which the volume was created.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The volume state.</p>"
|
||||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.</p>"
|
||||
},
|
||||
"Attachments":{
|
||||
"shape":"AwsEc2VolumeAttachmentList",
|
||||
"documentation":"<p>The volume attachments.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details about an EC2 volume.</p>"
|
||||
},
|
||||
"AwsEc2VpcDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CidrBlockAssociationSet":{
|
||||
"shape":"CidrBlockAssociationList",
|
||||
"documentation":"<p>Information about the IPv4 CIDR blocks associated with the VPC.</p>"
|
||||
},
|
||||
"Ipv6CidrBlockAssociationSet":{
|
||||
"shape":"Ipv6CidrBlockAssociationList",
|
||||
"documentation":"<p>Information about the IPv6 CIDR blocks associated with the VPC.</p>"
|
||||
},
|
||||
"DhcpOptionsId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.</p>"
|
||||
},
|
||||
"State":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The current state of the VPC.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details about an EC2 VPC.</p>"
|
||||
},
|
||||
"AwsElasticsearchDomainDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2051,6 +2159,10 @@
|
|||
"shape":"Network",
|
||||
"documentation":"<p>The details of network-related information about a finding.</p>"
|
||||
},
|
||||
"NetworkPath":{
|
||||
"shape":"NetworkPathList",
|
||||
"documentation":"<p>Provides information about a network path that is relevant to a finding. Each entry under <code>NetworkPath</code> represents a component of that path.</p>"
|
||||
},
|
||||
"Process":{
|
||||
"shape":"ProcessDetails",
|
||||
"documentation":"<p>The details of process-related information about a finding.</p>"
|
||||
|
|
@ -2090,6 +2202,10 @@
|
|||
"Note":{
|
||||
"shape":"Note",
|
||||
"documentation":"<p>A user-defined note added to a finding.</p>"
|
||||
},
|
||||
"Vulnerabilities":{
|
||||
"shape":"VulnerabilityList",
|
||||
"documentation":"<p>Provides a list of vulnerabilities associated with the findings.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides consistent format for the contents of the Security Hub-aggregated findings. <code>AwsSecurityFinding</code> format enables you to share findings between AWS security services and third-party solutions, and security standards checks.</p> <note> <p>A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.</p> </note>"
|
||||
|
|
@ -2741,6 +2857,28 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"NonEmptyString"}
|
||||
},
|
||||
"CidrBlockAssociation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AssociationId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The association ID for the IPv4 CIDR block.</p>"
|
||||
},
|
||||
"CidrBlock":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The IPv4 CIDR block.</p>"
|
||||
},
|
||||
"CidrBlockState":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>Information about the state of the IPv4 CIDR block.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An IPv4 CIDR block association.</p>"
|
||||
},
|
||||
"CidrBlockAssociationList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CidrBlockAssociation"}
|
||||
},
|
||||
"Compliance":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2879,6 +3017,28 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"Cvss":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Version":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The version of CVSS for the CVSS score.</p>"
|
||||
},
|
||||
"BaseScore":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>The base CVSS score.</p>"
|
||||
},
|
||||
"BaseVector":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The base scoring vector for the CVSS score.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>CVSS scores from the advisory related to the vulnerability.</p>"
|
||||
},
|
||||
"CvssList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Cvss"}
|
||||
},
|
||||
"DateFilter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3639,6 +3799,28 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"IpFilter"}
|
||||
},
|
||||
"Ipv6CidrBlockAssociation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AssociationId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The association ID for the IPv6 CIDR block.</p>"
|
||||
},
|
||||
"Ipv6CidrBlock":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The IPv6 CIDR block.</p>"
|
||||
},
|
||||
"CidrBlockState":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>Information about the state of the CIDR block.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An IPV6 CIDR block association.</p>"
|
||||
},
|
||||
"Ipv6CidrBlockAssociationList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Ipv6CidrBlockAssociation"}
|
||||
},
|
||||
"KeywordFilter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3925,6 +4107,10 @@
|
|||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The protocol of network-related information about a finding.</p>"
|
||||
},
|
||||
"OpenPortRange":{
|
||||
"shape":"PortRange",
|
||||
"documentation":"<p>The range of open ports that is present on the network.</p>"
|
||||
},
|
||||
"SourceIpV4":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The source IPv4 address of network-related information about a finding.</p>"
|
||||
|
|
@ -3971,6 +4157,64 @@
|
|||
"OUT"
|
||||
]
|
||||
},
|
||||
"NetworkHeader":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Protocol":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The protocol used for the component.</p>"
|
||||
},
|
||||
"Destination":{
|
||||
"shape":"NetworkPathComponentDetails",
|
||||
"documentation":"<p>Information about the destination of the component.</p>"
|
||||
},
|
||||
"Source":{
|
||||
"shape":"NetworkPathComponentDetails",
|
||||
"documentation":"<p>Information about the origin of the component.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details about a network path component that occurs before or after the current component.</p>"
|
||||
},
|
||||
"NetworkPathComponent":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ComponentId":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The identifier of a component in the network path.</p>"
|
||||
},
|
||||
"ComponentType":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The type of component.</p>"
|
||||
},
|
||||
"Egress":{
|
||||
"shape":"NetworkHeader",
|
||||
"documentation":"<p>Information about the component that comes after the current component in the network path.</p>"
|
||||
},
|
||||
"Ingress":{
|
||||
"shape":"NetworkHeader",
|
||||
"documentation":"<p>Information about the component that comes before the current node in the network path.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a network path component.</p>"
|
||||
},
|
||||
"NetworkPathComponentDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Address":{
|
||||
"shape":"StringList",
|
||||
"documentation":"<p>The IP addresses of the destination.</p>"
|
||||
},
|
||||
"PortRanges":{
|
||||
"shape":"PortRangeList",
|
||||
"documentation":"<p>A list of port ranges for the destination.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the destination of the next component in the network path.</p>"
|
||||
},
|
||||
"NetworkPathList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NetworkPathComponent"}
|
||||
},
|
||||
"NextToken":{"type":"string"},
|
||||
"NonEmptyString":{
|
||||
"type":"string",
|
||||
|
|
@ -4051,6 +4295,24 @@
|
|||
"aws-us-gov"
|
||||
]
|
||||
},
|
||||
"PortRange":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Begin":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The first port in the port range.</p>"
|
||||
},
|
||||
"End":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The last port in the port range.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A range of ports.</p>"
|
||||
},
|
||||
"PortRangeList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PortRange"}
|
||||
},
|
||||
"ProcessDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -4245,6 +4507,10 @@
|
|||
"ResourceDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AwsAutoScalingAutoScalingGroup":{
|
||||
"shape":"AwsAutoScalingAutoScalingGroupDetails",
|
||||
"documentation":"<p>Details for an autoscaling group.</p>"
|
||||
},
|
||||
"AwsCodeBuildProject":{
|
||||
"shape":"AwsCodeBuildProjectDetails",
|
||||
"documentation":"<p>Details for an AWS CodeBuild project.</p>"
|
||||
|
|
@ -4265,6 +4531,14 @@
|
|||
"shape":"AwsEc2SecurityGroupDetails",
|
||||
"documentation":"<p>Details for an EC2 security group.</p>"
|
||||
},
|
||||
"AwsEc2Volume":{
|
||||
"shape":"AwsEc2VolumeDetails",
|
||||
"documentation":"<p>Details for an EC2 volume.</p>"
|
||||
},
|
||||
"AwsEc2Vpc":{
|
||||
"shape":"AwsEc2VpcDetails",
|
||||
"documentation":"<p>Details for an EC2 VPC.</p>"
|
||||
},
|
||||
"AwsElbv2LoadBalancer":{
|
||||
"shape":"AwsElbv2LoadBalancerDetails",
|
||||
"documentation":"<p>Details about a load balancer.</p>"
|
||||
|
|
@ -4423,6 +4697,36 @@
|
|||
},
|
||||
"documentation":"<p>Updates to the severity information for a finding.</p>"
|
||||
},
|
||||
"SoftwarePackage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The name of the software package.</p>"
|
||||
},
|
||||
"Version":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The version of the software package.</p>"
|
||||
},
|
||||
"Epoch":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The epoch of the software package.</p>"
|
||||
},
|
||||
"Release":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The release of the software package.</p>"
|
||||
},
|
||||
"Architecture":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The architecture used for the software package.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a software package.</p>"
|
||||
},
|
||||
"SoftwarePackageList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SoftwarePackage"}
|
||||
},
|
||||
"SortCriteria":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SortCriterion"}
|
||||
|
|
@ -4881,7 +5185,7 @@
|
|||
},
|
||||
"DisabledReason":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>A description of the reason why you are disabling a security standard control.</p>"
|
||||
"documentation":"<p>A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4899,6 +5203,68 @@
|
|||
"BENIGN_POSITIVE"
|
||||
]
|
||||
},
|
||||
"Vulnerability":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The identifier of the vulnerability.</p>"
|
||||
},
|
||||
"VulnerablePackages":{
|
||||
"shape":"SoftwarePackageList",
|
||||
"documentation":"<p>List of software packages that have the vulnerability.</p>"
|
||||
},
|
||||
"Cvss":{
|
||||
"shape":"CvssList",
|
||||
"documentation":"<p>CVSS scores from the advisory related to the vulnerability.</p>"
|
||||
},
|
||||
"RelatedVulnerabilities":{
|
||||
"shape":"StringList",
|
||||
"documentation":"<p>List of vulnerabilities that are related to this vulnerability.</p>"
|
||||
},
|
||||
"Vendor":{
|
||||
"shape":"VulnerabilityVendor",
|
||||
"documentation":"<p>Information about the vendor that generates the vulnerability report.</p>"
|
||||
},
|
||||
"ReferenceUrls":{
|
||||
"shape":"StringList",
|
||||
"documentation":"<p>A list of URLs that provide additional information about the vulnerability.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A vulnerability associated with a finding.</p>"
|
||||
},
|
||||
"VulnerabilityList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Vulnerability"}
|
||||
},
|
||||
"VulnerabilityVendor":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The name of the vendor.</p>"
|
||||
},
|
||||
"Url":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The URL of the vulnerability advisory.</p>"
|
||||
},
|
||||
"VendorSeverity":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The severity that the vendor assigned to the vulnerability.</p>"
|
||||
},
|
||||
"VendorCreatedAt":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The datetime when the vulnerability advisory was created.</p>"
|
||||
},
|
||||
"VendorUpdatedAt":{
|
||||
"shape":"NonEmptyString",
|
||||
"documentation":"<p>The datetime when the vulnerability advisory was last updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A vendor that generates a vulnerability report.</p>"
|
||||
},
|
||||
"WafAction":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@
|
|||
{"shape":"InternalErrorException"},
|
||||
{"shape":"AuthorizationErrorException"}
|
||||
],
|
||||
"documentation":"<p>Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the <code>CreatePlatformApplication</code> action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For FCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is \"Package Security Identifier\". For MPNS, PlatformPrincipal is \"TLS certificate\". For Baidu, PlatformPrincipal is \"API key\".</p> <p>For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For FCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". For WNS, PlatformCredential is \"secret key\". For MPNS, PlatformCredential is \"private key\". For Baidu, PlatformCredential is \"secret key\". The PlatformApplicationArn that is returned when using <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action.</p>"
|
||||
"documentation":"<p>Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify <code>PlatformPrincipal</code> and <code>PlatformCredential</code> attributes when using the <code>CreatePlatformApplication</code> action.</p> <p> <code>PlatformPrincipal</code> and <code>PlatformCredential</code> are received from the notification service.</p> <ul> <li> <p>For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code> and <code>PlatformCredential</code> is <code>client secret</code>.</p> </li> <li> <p>For <code>Baidu</code>, <code>PlatformPrincipal</code> is <code>API key</code> and <code>PlatformCredential</code> is <code>secret key</code>.</p> </li> <li> <p>For <code>APNS</code> and <code>APNS_SANDBOX</code>, <code>PlatformPrincipal</code> is <code>SSL certificate</code> and <code>PlatformCredential</code> is <code>private key</code>.</p> </li> <li> <p>For <code>GCM</code> (Firebase Cloud Messaging), there is no <code>PlatformPrincipal</code> and the <code>PlatformCredential</code> is <code>API key</code>.</p> </li> <li> <p>For <code>MPNS</code>, <code>PlatformPrincipal</code> is <code>TLS certificate</code> and <code>PlatformCredential</code> is <code>private key</code>.</p> </li> <li> <p>For <code>WNS</code>, <code>PlatformPrincipal</code> is <code>Package Security Identifier</code> and <code>PlatformCredential</code> is <code>secret key</code>.</p> </li> </ul> <p>You can use the returned <code>PlatformApplicationArn</code> as an attribute for the <code>CreatePlatformEndpoint</code> action.</p>"
|
||||
},
|
||||
"CreatePlatformEndpoint":{
|
||||
"name":"CreatePlatformEndpoint",
|
||||
|
|
@ -102,7 +102,7 @@
|
|||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM and APNS. <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p> <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html\">Creating an Amazon SNS Endpoint for Baidu</a>. </p>"
|
||||
"documentation":"<p>Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. <code>CreatePlatformEndpoint</code> requires the <code>PlatformApplicationArn</code> that is returned from <code>CreatePlatformApplication</code>. You can use the returned <code>EndpointArn</code> to send a message to a mobile app or by the <code>Subscribe</code> action for subscription to a topic. The <code>CreatePlatformEndpoint</code> action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p> <p>When using <code>CreatePlatformEndpoint</code> with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html\">Creating an Amazon SNS Endpoint for Baidu</a>. </p>"
|
||||
},
|
||||
"CreateTopic":{
|
||||
"name":"CreateTopic",
|
||||
|
|
@ -126,7 +126,7 @@
|
|||
{"shape":"TagPolicyException"},
|
||||
{"shape":"ConcurrentAccessException"}
|
||||
],
|
||||
"documentation":"<p>Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see <a href=\"http://aws.amazon.com/sns/\">https://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.</p>"
|
||||
"documentation":"<p>Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see <a href=\"http://aws.amazon.com/sns/\">https://aws.amazon.com/sns</a>. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.</p>"
|
||||
},
|
||||
"DeleteEndpoint":{
|
||||
"name":"DeleteEndpoint",
|
||||
|
|
@ -154,7 +154,7 @@
|
|||
{"shape":"InternalErrorException"},
|
||||
{"shape":"AuthorizationErrorException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a platform application object for one of the supported push notification services, such as APNS and FCM. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
"documentation":"<p>Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
},
|
||||
"DeleteTopic":{
|
||||
"name":"DeleteTopic",
|
||||
|
|
@ -191,7 +191,7 @@
|
|||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the endpoint attributes for a device on one of the supported push notification services, such as FCM and APNS. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
"documentation":"<p>Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
},
|
||||
"GetPlatformApplicationAttributes":{
|
||||
"name":"GetPlatformApplicationAttributes",
|
||||
|
|
@ -210,7 +210,7 @@
|
|||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
"documentation":"<p>Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
},
|
||||
"GetSMSAttributes":{
|
||||
"name":"GetSMSAttributes",
|
||||
|
|
@ -287,7 +287,7 @@
|
|||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM and APNS. The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p> <p>This action is throttled at 30 transactions per second (TPS).</p>"
|
||||
"documentation":"<p>Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p> <p>This action is throttled at 30 transactions per second (TPS).</p>"
|
||||
},
|
||||
"ListPhoneNumbersOptedOut":{
|
||||
"name":"ListPhoneNumbersOptedOut",
|
||||
|
|
@ -324,7 +324,7 @@
|
|||
{"shape":"InternalErrorException"},
|
||||
{"shape":"AuthorizationErrorException"}
|
||||
],
|
||||
"documentation":"<p>Lists the platform application objects for the supported push notification services, such as APNS and FCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p> <p>This action is throttled at 15 transactions per second (TPS).</p>"
|
||||
"documentation":"<p>Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. When there are no more records to return, <code>NextToken</code> will be null. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p> <p>This action is throttled at 15 transactions per second (TPS).</p>"
|
||||
},
|
||||
"ListSubscriptions":{
|
||||
"name":"ListSubscriptions",
|
||||
|
|
@ -447,7 +447,7 @@
|
|||
{"shape":"KMSAccessDeniedException"},
|
||||
{"shape":"InvalidSecurityException"}
|
||||
],
|
||||
"documentation":"<p>Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number. </p> <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.</p> <p>When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.</p> <p>To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. </p> <p>For more information about formatting messages, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html\">Send Custom Platform-Specific Payloads in Messages to Mobile Devices</a>. </p>"
|
||||
"documentation":"<p>Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the <code>TargetArn</code>).</p> <p>If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.</p> <p>When a <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.</p> <p>To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. </p> <p>For more information about formatting messages, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html\">Send Custom Platform-Specific Payloads in Messages to Mobile Devices</a>. </p> <important> <p>You can publish messages only to topics and endpoints in the same AWS Region.</p> </important>"
|
||||
},
|
||||
"RemovePermission":{
|
||||
"name":"RemovePermission",
|
||||
|
|
@ -477,7 +477,7 @@
|
|||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM and APNS. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
"documentation":"<p>Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. </p>"
|
||||
},
|
||||
"SetPlatformApplicationAttributes":{
|
||||
"name":"SetPlatformApplicationAttributes",
|
||||
|
|
@ -492,7 +492,7 @@
|
|||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Sets the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring attributes for message delivery status, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html\">Using Amazon SNS Application Attributes for Message Delivery Status</a>. </p>"
|
||||
"documentation":"<p>Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. For information on configuring attributes for message delivery status, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html\">Using Amazon SNS Application Attributes for Message Delivery Status</a>. </p>"
|
||||
},
|
||||
"SetSMSAttributes":{
|
||||
"name":"SetSMSAttributes",
|
||||
|
|
@ -565,7 +565,7 @@
|
|||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"InvalidSecurityException"}
|
||||
],
|
||||
"documentation":"<p>Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the <code>ConfirmSubscription</code> action with the token from the confirmation message. Confirmation tokens are valid for three days.</p> <p>This action is throttled at 100 transactions per second (TPS).</p>"
|
||||
"documentation":"<p>Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same AWS account, the endpoint owner must the <code>ConfirmSubscription</code> action to confirm the subscription.</p> <p>You call the <code>ConfirmSubscription</code> action with the token from the subscription response. Confirmation tokens are valid for three days.</p> <p>This action is throttled at 100 transactions per second (TPS).</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -769,7 +769,7 @@
|
|||
},
|
||||
"Platform":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).</p>"
|
||||
"documentation":"<p>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).</p>"
|
||||
},
|
||||
"Attributes":{
|
||||
"shape":"MapStringToString",
|
||||
|
|
@ -801,7 +801,7 @@
|
|||
},
|
||||
"Token":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using FCM or ADM, the device token equivalent is called the registration ID.</p>"
|
||||
"documentation":"<p>Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.</p>"
|
||||
},
|
||||
"CustomUserData":{
|
||||
"shape":"String",
|
||||
|
|
@ -820,11 +820,11 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"topicName",
|
||||
"documentation":"<p>The name of the topic you want to create.</p> <p>Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.</p>"
|
||||
"documentation":"<p>The name of the topic you want to create.</p> <p>Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.</p> <p>For a FIFO (first-in-first-out) topic, the name must end with the <code>.fifo</code> suffix. </p>"
|
||||
},
|
||||
"Attributes":{
|
||||
"shape":"TopicAttributesMap",
|
||||
"documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. </p> </li> </ul>"
|
||||
"documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>CreateTopic</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>FifoTopic</code> – Set to true to create a FIFO topic.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. </p> </li> </ul> <p>The following attribute applies only to FIFO topics:</p> <ul> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). </p> </li> <li> <p> When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. </p> </li> <li> <p> If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. </p> </li> </ul>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
|
|
@ -1000,7 +1000,7 @@
|
|||
"members":{
|
||||
"Attributes":{
|
||||
"shape":"SubscriptionAttributesMap",
|
||||
"documentation":"<p>A map of the subscription's attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>ConfirmationWasAuthenticated</code> – <code>true</code> if the subscription confirmation request was authenticated.</p> </li> <li> <p> <code>DeliveryPolicy</code> – The JSON serialization of the subscription's delivery policy.</p> </li> <li> <p> <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.</p> </li> <li> <p> <code>FilterPolicy</code> – The filter policy JSON that is assigned to the subscription.</p> </li> <li> <p> <code>Owner</code> – The AWS account ID of the subscription's owner.</p> </li> <li> <p> <code>PendingConfirmation</code> – <code>true</code> if the subscription hasn't been confirmed. To confirm a pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.</p> </li> <li> <p> <code>RawMessageDelivery</code> – <code>true</code> if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.</p> </li> <li> <p> <code>RedrivePolicy</code> – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN that the subscription is associated with.</p> </li> </ul>"
|
||||
"documentation":"<p>A map of the subscription's attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>ConfirmationWasAuthenticated</code> – <code>true</code> if the subscription confirmation request was authenticated.</p> </li> <li> <p> <code>DeliveryPolicy</code> – The JSON serialization of the subscription's delivery policy.</p> </li> <li> <p> <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.</p> </li> <li> <p> <code>FilterPolicy</code> – The filter policy JSON that is assigned to the subscription. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-message-filtering.html\">Amazon SNS Message Filtering</a> in the <i>Amazon SNS Developer Guide</i>.</p> </li> <li> <p> <code>Owner</code> – The AWS account ID of the subscription's owner.</p> </li> <li> <p> <code>PendingConfirmation</code> – <code>true</code> if the subscription hasn't been confirmed. To confirm a pending subscription, call the <code>ConfirmSubscription</code> action with a confirmation token.</p> </li> <li> <p> <code>RawMessageDelivery</code> – <code>true</code> if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.</p> </li> <li> <p> <code>RedrivePolicy</code> – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.</p> </li> <li> <p> <code>SubscriptionArn</code> – The subscription's ARN.</p> </li> <li> <p> <code>TopicArn</code> – The topic ARN that the subscription is associated with.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for GetSubscriptionAttributes action.</p>"
|
||||
|
|
@ -1021,7 +1021,7 @@
|
|||
"members":{
|
||||
"Attributes":{
|
||||
"shape":"TopicAttributesMap",
|
||||
"documentation":"<p>A map of the topic's attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The JSON serialization of the topic's delivery policy.</p> </li> <li> <p> <code>DisplayName</code> – The human-readable name used in the <code>From</code> field for notifications to <code>email</code> and <code>email-json</code> endpoints.</p> </li> <li> <p> <code>Owner</code> – The AWS account ID of the topic's owner.</p> </li> <li> <p> <code>Policy</code> – The JSON serialization of the topic's access control policy.</p> </li> <li> <p> <code>SubscriptionsConfirmed</code> – The number of confirmed subscriptions for the topic.</p> </li> <li> <p> <code>SubscriptionsDeleted</code> – The number of deleted subscriptions for the topic.</p> </li> <li> <p> <code>SubscriptionsPending</code> – The number of subscriptions pending confirmation for the topic.</p> </li> <li> <p> <code>TopicArn</code> – The topic's ARN.</p> </li> <li> <p> <code>EffectiveDeliveryPolicy</code> – Yhe JSON serialization of the effective delivery policy, taking system defaults into account.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>AWS Key Management Service API Reference</i>.</p> </li> </ul>"
|
||||
"documentation":"<p>A map of the topic's attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The JSON serialization of the topic's delivery policy.</p> </li> <li> <p> <code>DisplayName</code> – The human-readable name used in the <code>From</code> field for notifications to <code>email</code> and <code>email-json</code> endpoints.</p> </li> <li> <p> <code>Owner</code> – The AWS account ID of the topic's owner.</p> </li> <li> <p> <code>Policy</code> – The JSON serialization of the topic's access control policy.</p> </li> <li> <p> <code>SubscriptionsConfirmed</code> – The number of confirmed subscriptions for the topic.</p> </li> <li> <p> <code>SubscriptionsDeleted</code> – The number of deleted subscriptions for the topic.</p> </li> <li> <p> <code>SubscriptionsPending</code> – The number of subscriptions pending confirmation for the topic.</p> </li> <li> <p> <code>TopicArn</code> – The topic's ARN.</p> </li> <li> <p> <code>EffectiveDeliveryPolicy</code> – The JSON serialization of the effective delivery policy, taking system defaults into account.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>AWS Key Management Service API Reference</i>.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Response for GetTopicAttributes action.</p>"
|
||||
|
|
@ -1550,7 +1550,7 @@
|
|||
},
|
||||
"Attributes":{
|
||||
"shape":"MapStringToString",
|
||||
"documentation":"<p>A map of the platform application attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>PlatformCredential</code> – The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For FCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\".</p> </li> <li> <p> <code>PlatformPrincipal</code> – The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For FCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\".</p> </li> <li> <p> <code>EventEndpointCreated</code> – Topic ARN to which EndpointCreated event notifications should be sent.</p> </li> <li> <p> <code>EventEndpointDeleted</code> – Topic ARN to which EndpointDeleted event notifications should be sent.</p> </li> <li> <p> <code>EventEndpointUpdated</code> – Topic ARN to which EndpointUpdate event notifications should be sent.</p> </li> <li> <p> <code>EventDeliveryFailure</code> – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</p> </li> <li> <p> <code>SuccessFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li> <li> <p> <code>FailureFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li> <li> <p> <code>SuccessFeedbackSampleRate</code> – Sample rate percentage (0-100) of successfully delivered messages.</p> </li> </ul>"
|
||||
"documentation":"<p>A map of the platform application attributes. Attributes in this map include the following:</p> <ul> <li> <p> <code>PlatformCredential</code> – The credential received from the notification service. For <code>APNS</code> and <code>APNS_SANDBOX</code>, <code>PlatformCredential</code> is <code>private key</code>. For <code>GCM</code> (Firebase Cloud Messaging), <code>PlatformCredential</code> is <code>API key</code>. For <code>ADM</code>, <code>PlatformCredential</code> is <code>client secret</code>.</p> </li> <li> <p> <code>PlatformPrincipal</code> – The principal received from the notification service. For <code>APNS</code> and <code>APNS_SANDBOX</code>, <code>PlatformPrincipal</code> is <code>SSL certificate</code>. For <code>GCM</code> (Firebase Cloud Messaging), there is no <code>PlatformPrincipal</code>. For <code>ADM</code>, <code>PlatformPrincipal</code> is <code>client id</code>.</p> </li> <li> <p> <code>EventEndpointCreated</code> – Topic ARN to which <code>EndpointCreated</code> event notifications are sent.</p> </li> <li> <p> <code>EventEndpointDeleted</code> – Topic ARN to which <code>EndpointDeleted</code> event notifications are sent.</p> </li> <li> <p> <code>EventEndpointUpdated</code> – Topic ARN to which <code>EndpointUpdate</code> event notifications are sent.</p> </li> <li> <p> <code>EventDeliveryFailure</code> – Topic ARN to which <code>DeliveryFailure</code> event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</p> </li> <li> <p> <code>SuccessFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li> <li> <p> <code>FailureFeedbackRoleArn</code> – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.</p> </li> <li> <p> <code>SuccessFeedbackSampleRate</code> – Sample rate percentage (0-100) of successfully delivered messages.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Input for SetPlatformApplicationAttributes action.</p>"
|
||||
|
|
@ -1607,7 +1607,7 @@
|
|||
},
|
||||
"AttributeName":{
|
||||
"shape":"attributeName",
|
||||
"documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. </p> </li> </ul>"
|
||||
"documentation":"<p>A map of attributes with their corresponding values.</p> <p>The following lists the names, descriptions, and values of the special request parameters that the <code>SetTopicAttributes</code> action uses:</p> <ul> <li> <p> <code>DeliveryPolicy</code> – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.</p> </li> <li> <p> <code>DisplayName</code> – The display name to use for a topic with SMS subscriptions.</p> </li> <li> <p> <code>Policy</code> – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.</p> </li> </ul> <p>The following attribute applies only to <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html\">server-side-encryption</a>:</p> <ul> <li> <p> <code>KmsMasterKeyId</code> – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms\">Key Terms</a>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the <i>AWS Key Management Service API Reference</i>. </p> </li> </ul> <p>The following attribute applies only to FIFO topics:</p> <ul> <li> <p> <code>ContentBasedDeduplication</code> – Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). </p> </li> <li> <p> When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. </p> </li> <li> <p> If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. </p> </li> </ul>"
|
||||
},
|
||||
"AttributeValue":{
|
||||
"shape":"attributeValue",
|
||||
|
|
@ -1647,7 +1647,7 @@
|
|||
},
|
||||
"Endpoint":{
|
||||
"shape":"endpoint",
|
||||
"documentation":"<p>The endpoint that you want to receive notifications. Endpoints vary by protocol:</p> <ul> <li> <p>For the <code>http</code> protocol, the endpoint is an URL beginning with <code>http://</code> </p> </li> <li> <p>For the <code>https</code> protocol, the endpoint is a URL beginning with <code>https://</code> </p> </li> <li> <p>For the <code>email</code> protocol, the endpoint is an email address</p> </li> <li> <p>For the <code>email-json</code> protocol, the endpoint is an email address</p> </li> <li> <p>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device</p> </li> <li> <p>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue</p> </li> <li> <p>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</p> </li> <li> <p>For the <code>lambda</code> protocol, the endpoint is the ARN of an Amazon Lambda function.</p> </li> </ul>"
|
||||
"documentation":"<p>The endpoint that you want to receive notifications. Endpoints vary by protocol:</p> <ul> <li> <p>For the <code>http</code> protocol, the (public) endpoint is a URL beginning with <code>http://</code> </p> </li> <li> <p>For the <code>https</code> protocol, the (public) endpoint is a URL beginning with <code>https://</code> </p> </li> <li> <p>For the <code>email</code> protocol, the endpoint is an email address</p> </li> <li> <p>For the <code>email-json</code> protocol, the endpoint is an email address</p> </li> <li> <p>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device</p> </li> <li> <p>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue</p> </li> <li> <p>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</p> </li> <li> <p>For the <code>lambda</code> protocol, the endpoint is the ARN of an Amazon Lambda function.</p> </li> </ul>"
|
||||
},
|
||||
"Attributes":{
|
||||
"shape":"SubscriptionAttributesMap",
|
||||
|
|
@ -1655,7 +1655,7 @@
|
|||
},
|
||||
"ReturnSubscriptionArn":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Sets whether the response from the <code>Subscribe</code> request includes the subscription ARN, even if the subscription is not yet confirmed.</p> <ul> <li> <p>If you have the subscription ARN returned, the response includes the ARN in all cases, even if the subscription is not yet confirmed.</p> </li> <li> <p>If you don't have the subscription ARN returned, in addition to the ARN for confirmed subscriptions, the response also includes the <code>pending subscription</code> ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the <code>ConfirmSubscription</code> action with a confirmation token.</p> </li> </ul> <p>If you set this parameter to <code>true</code>, .</p> <p>The default value is <code>false</code>.</p>"
|
||||
"documentation":"<p>Sets whether the response from the <code>Subscribe</code> request includes the subscription ARN, even if the subscription is not yet confirmed.</p> <ul> <li> <p>If you set this parameter to <code>true</code>, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the <code>pending subscription</code> ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the <code>ConfirmSubscription</code> action with a confirmation token.</p> </li> </ul> <p/> <p>The default value is <code>false</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Input for Subscribe action.</p>"
|
||||
|
|
|
|||
|
|
@ -824,7 +824,7 @@
|
|||
{"shape":"InvalidGatewayRequestException"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>AWS Storage Gateway User Guide</i>.</p> <p>When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your <code>RefreshCache</code> operation completes.</p> <p>Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>AWS Storage Gateway User Guide</i>.</p> <p>If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an <code>InvalidGatewayRequestException</code> error because too many requests were sent to the server.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>AWS Storage Gateway User Guide</i>.</p>"
|
||||
"documentation":"<p>Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>AWS Storage Gateway User Guide</i>.</p> <p>When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your <code>RefreshCache</code> operation completes.</p> <p>Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>AWS Storage Gateway User Guide</i>.</p> <p>If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an <code>InvalidGatewayRequestException</code> error because too many requests were sent to the server.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-notification\">Getting notified about file operations</a> in the <i>AWS Storage Gateway User Guide</i>.</p>"
|
||||
},
|
||||
"RemoveTagsFromResource":{
|
||||
"name":"RemoveTagsFromResource",
|
||||
|
|
@ -1418,6 +1418,17 @@
|
|||
"min":51200
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"CacheAttributes":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CacheStaleTimeoutInSeconds":{
|
||||
"shape":"CacheStaleTimeoutInSeconds",
|
||||
"documentation":"<p>Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.</p> <p>Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Lists refresh cache information.</p>"
|
||||
},
|
||||
"CacheStaleTimeoutInSeconds":{"type":"integer"},
|
||||
"CachediSCSIVolume":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1527,6 +1538,13 @@
|
|||
},
|
||||
"documentation":"<p>CancelRetrievalOutput</p>"
|
||||
},
|
||||
"CaseSensitivity":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ClientSpecified",
|
||||
"CaseSensitive"
|
||||
]
|
||||
},
|
||||
"ChapCredentials":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ChapInfo"}
|
||||
|
|
@ -1665,7 +1683,7 @@
|
|||
},
|
||||
"LocationARN":{
|
||||
"shape":"LocationARN",
|
||||
"documentation":"<p>The ARN of the backed storage used for storing file data.</p>"
|
||||
"documentation":"<p>The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a \"/\".</p>"
|
||||
},
|
||||
"DefaultStorageClass":{
|
||||
"shape":"StorageClass",
|
||||
|
|
@ -1698,6 +1716,14 @@
|
|||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A list of up to 50 tags that can be assigned to the NFS file share. 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>"
|
||||
},
|
||||
"FileShareName":{
|
||||
"shape":"FileShareName",
|
||||
"documentation":"<p>The name of the file share. Optional.</p> <note> <p> <code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>.</p> </note>"
|
||||
},
|
||||
"CacheAttributes":{
|
||||
"shape":"CacheAttributes",
|
||||
"documentation":"<p>Refresh cache information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>CreateNFSFileShareInput</p>"
|
||||
|
|
@ -1743,7 +1769,7 @@
|
|||
},
|
||||
"LocationARN":{
|
||||
"shape":"LocationARN",
|
||||
"documentation":"<p>The ARN of the backed storage used for storing file data.</p>"
|
||||
"documentation":"<p>The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a \"/\".</p>"
|
||||
},
|
||||
"DefaultStorageClass":{
|
||||
"shape":"StorageClass",
|
||||
|
|
@ -1771,15 +1797,15 @@
|
|||
},
|
||||
"AdminUserList":{
|
||||
"shape":"FileShareUserList",
|
||||
"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>"
|
||||
"documentation":"<p>A list of users or groups 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. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>.</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",
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file <a href=\"\"/> share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"InvalidUserList":{
|
||||
"shape":"FileShareUserList",
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example, <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"AuditDestinationARN":{
|
||||
"shape":"AuditDestinationARN",
|
||||
|
|
@ -1789,9 +1815,21 @@
|
|||
"shape":"Authentication",
|
||||
"documentation":"<p>The authentication method that users use to access the file share. The default is <code>ActiveDirectory</code>.</p> <p>Valid Values: <code>ActiveDirectory</code> | <code>GuestAccess</code> </p>"
|
||||
},
|
||||
"CaseSensitivity":{
|
||||
"shape":"CaseSensitivity",
|
||||
"documentation":"<p>The case of an object name in an Amazon S3 bucket. For <code>ClientSpecified</code>, the client determines the case sensitivity. For <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default value is <code>ClientSpecified</code>.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A list of up to 50 tags that can be assigned to the NFS file share. 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>"
|
||||
},
|
||||
"FileShareName":{
|
||||
"shape":"FileShareName",
|
||||
"documentation":"<p>The name of the file share. Optional.</p> <note> <p> <code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>.</p> </note>"
|
||||
},
|
||||
"CacheAttributes":{
|
||||
"shape":"CacheAttributes",
|
||||
"documentation":"<p>Refresh cache information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>CreateSMBFileShareInput</p>"
|
||||
|
|
@ -3078,6 +3116,11 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"FileShareInfo"}
|
||||
},
|
||||
"FileShareName":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"FileShareStatus":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The status of the file share.</p> <p>Valid Values: <code>CREATING</code> | <code>UPDATING</code> | <code>AVAILABLE</code> | <code>DELETING</code> </p>",
|
||||
|
|
@ -3196,6 +3239,8 @@
|
|||
},
|
||||
"Host":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":6,
|
||||
"pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(:(\\d+))?$"
|
||||
},
|
||||
"HostEnvironment":{
|
||||
|
|
@ -3324,7 +3369,8 @@
|
|||
"type":"string",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.</p>",
|
||||
"max":2048,
|
||||
"min":7
|
||||
"min":7,
|
||||
"pattern":"(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)"
|
||||
},
|
||||
"LastSoftwareUpdate":{
|
||||
"type":"string",
|
||||
|
|
@ -3567,8 +3613,8 @@
|
|||
},
|
||||
"LocationARN":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The ARN of the backend storage used for storing file data.</p>",
|
||||
"max":310,
|
||||
"documentation":"<p>The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a \"/\".</p>",
|
||||
"max":1400,
|
||||
"min":16
|
||||
},
|
||||
"Marker":{
|
||||
|
|
@ -3651,6 +3697,14 @@
|
|||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A list of up to 50 tags assigned to the NFS file share, 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>"
|
||||
},
|
||||
"FileShareName":{
|
||||
"shape":"FileShareName",
|
||||
"documentation":"<p>The name of the file share. Optional.</p> <note> <p> <code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>.</p> </note>"
|
||||
},
|
||||
"CacheAttributes":{
|
||||
"shape":"CacheAttributes",
|
||||
"documentation":"<p>Refresh cache information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.</p>"
|
||||
|
|
@ -3893,7 +3947,8 @@
|
|||
"type":"string",
|
||||
"documentation":"<p>The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.</p>",
|
||||
"max":2048,
|
||||
"min":20
|
||||
"min":20,
|
||||
"pattern":"^arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\\S+)$"
|
||||
},
|
||||
"SMBFileShareInfo":{
|
||||
"type":"structure",
|
||||
|
|
@ -3936,24 +3991,36 @@
|
|||
},
|
||||
"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 or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"ValidUserList":{
|
||||
"shape":"FileShareUserList",
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"InvalidUserList":{
|
||||
"shape":"FileShareUserList",
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"AuditDestinationARN":{
|
||||
"shape":"AuditDestinationARN",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the storage used for the audit logs.</p>"
|
||||
},
|
||||
"Authentication":{"shape":"Authentication"},
|
||||
"CaseSensitivity":{
|
||||
"shape":"CaseSensitivity",
|
||||
"documentation":"<p>The case of an object name in an Amazon S3 bucket. For <code>ClientSpecified</code>, the client determines the case sensitivity. For <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default value is <code>ClientSpecified</code>.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A list of up to 50 tags assigned to the SMB file share, 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>"
|
||||
},
|
||||
"FileShareName":{
|
||||
"shape":"FileShareName",
|
||||
"documentation":"<p>The name of the file share. Optional.</p> <note> <p> <code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>.</p> </note>"
|
||||
},
|
||||
"CacheAttributes":{
|
||||
"shape":"CacheAttributes",
|
||||
"documentation":"<p>Refresh cache information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported for file gateways.</p>"
|
||||
|
|
@ -4631,6 +4698,14 @@
|
|||
"RequesterPays":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to <code>true</code>, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.</p> <note> <p> <code>RequesterPays</code> is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.</p> </note> <p>Valid Values: <code>true</code> | <code>false</code> </p>"
|
||||
},
|
||||
"FileShareName":{
|
||||
"shape":"FileShareName",
|
||||
"documentation":"<p>The name of the file share. Optional.</p> <note> <p> <code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>.</p> </note>"
|
||||
},
|
||||
"CacheAttributes":{
|
||||
"shape":"CacheAttributes",
|
||||
"documentation":"<p>Refresh cache information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>UpdateNFSFileShareInput</p>"
|
||||
|
|
@ -4687,19 +4762,31 @@
|
|||
},
|
||||
"AdminUserList":{
|
||||
"shape":"FileShareUserList",
|
||||
"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>"
|
||||
"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. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"ValidUserList":{
|
||||
"shape":"FileShareUserList",
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"InvalidUserList":{
|
||||
"shape":"FileShareUserList",
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example <code>@group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
"documentation":"<p>A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: <code>DOMAIN\\User1</code>, <code>user1</code>, <code>@group1</code>, and <code>@DOMAIN\\group1</code>. Can only be set if Authentication is set to <code>ActiveDirectory</code>.</p>"
|
||||
},
|
||||
"AuditDestinationARN":{
|
||||
"shape":"AuditDestinationARN",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the storage used for the audit logs.</p>"
|
||||
},
|
||||
"CaseSensitivity":{
|
||||
"shape":"CaseSensitivity",
|
||||
"documentation":"<p>The case of an object name in an Amazon S3 bucket. For <code>ClientSpecified</code>, the client determines the case sensitivity. For <code>CaseSensitive</code>, the gateway determines the case sensitivity. The default value is <code>ClientSpecified</code>.</p>"
|
||||
},
|
||||
"FileShareName":{
|
||||
"shape":"FileShareName",
|
||||
"documentation":"<p>The name of the file share. Optional.</p> <note> <p> <code>FileShareName</code> must be set if an S3 prefix name is set in <code>LocationARN</code>.</p> </note>"
|
||||
},
|
||||
"CacheAttributes":{
|
||||
"shape":"CacheAttributes",
|
||||
"documentation":"<p>Refresh cache information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>UpdateSMBFileShareInput</p>"
|
||||
|
|
|
|||
|
|
@ -548,7 +548,7 @@
|
|||
{"shape":"WAFTagOperationInternalErrorException"},
|
||||
{"shape":"WAFInvalidOperationException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Retrieves the <a>TagInfoForResource</a> for the specified resource. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Retrieves the <a>TagInfoForResource</a> for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.</p> <p>You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. </p>"
|
||||
},
|
||||
"ListWebACLs":{
|
||||
"name":"ListWebACLs",
|
||||
|
|
@ -579,9 +579,10 @@
|
|||
{"shape":"WAFOptimisticLockException"},
|
||||
{"shape":"WAFServiceLinkedRoleErrorException"},
|
||||
{"shape":"WAFInvalidParameterException"},
|
||||
{"shape":"WAFInvalidOperationException"}
|
||||
{"shape":"WAFInvalidOperationException"},
|
||||
{"shape":"WAFLimitsExceededException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided.</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. 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":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided.</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. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). </p> <p>Give the data firehose a name that starts with the prefix <code>aws-waf-logs-</code>. For example, <code>aws-waf-logs-us-east-2-analytics</code>.</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",
|
||||
|
|
@ -616,7 +617,7 @@
|
|||
{"shape":"WAFTagOperationInternalErrorException"},
|
||||
{"shape":"WAFInvalidOperationException"}
|
||||
],
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Associates tags with the specified AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.</p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.</p> <p>You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. </p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
|
|
@ -1579,6 +1580,13 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"ExcludedRule"}
|
||||
},
|
||||
"FallbackBehavior":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"MATCH",
|
||||
"NO_MATCH"
|
||||
]
|
||||
},
|
||||
"FieldToMatch":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1658,12 +1666,48 @@
|
|||
},
|
||||
"documentation":"<p>The processing guidance for an AWS Firewall Manager rule. This is like a regular rule <a>Statement</a>, but it can only contain a rule group reference.</p>"
|
||||
},
|
||||
"ForwardedIPConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"HeaderName",
|
||||
"FallbackBehavior"
|
||||
],
|
||||
"members":{
|
||||
"HeaderName":{
|
||||
"shape":"ForwardedIPHeaderName",
|
||||
"documentation":"<p>The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to <code>X-Forwarded-For</code>.</p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note>"
|
||||
},
|
||||
"FallbackBehavior":{
|
||||
"shape":"FallbackBehavior",
|
||||
"documentation":"<p>The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.</p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note> <p>You can specify the following fallback behaviors:</p> <ul> <li> <p>MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.</p> </li> <li> <p>NO_MATCH - Treat the web request as not matching the rule statement.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. </p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note> <p>This configuration is used for <a>GeoMatchStatement</a> and <a>RateBasedStatement</a>. For <a>IPSetReferenceStatement</a>, use <a>IPSetForwardedIPConfig</a> instead. </p> <p>AWS WAF only evaluates the first IP address found in the specified HTTP header. </p>"
|
||||
},
|
||||
"ForwardedIPHeaderName":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"^[a-zA-Z0-9-]+$"
|
||||
},
|
||||
"ForwardedIPPosition":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"FIRST",
|
||||
"LAST",
|
||||
"ANY"
|
||||
]
|
||||
},
|
||||
"GeoMatchStatement":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CountryCodes":{
|
||||
"shape":"CountryCodes",
|
||||
"documentation":"<p>An array of two-character country codes, for example, <code>[ \"US\", \"CN\" ]</code>, from the alpha-2 country ISO codes of the ISO 3166 international standard. </p>"
|
||||
},
|
||||
"ForwardedIPConfig":{
|
||||
"shape":"ForwardedIPConfig",
|
||||
"documentation":"<p>The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. </p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>A rule statement used to identify web requests based on country of origin. </p>"
|
||||
|
|
@ -1875,7 +1919,7 @@
|
|||
},
|
||||
"TimeWindow":{
|
||||
"shape":"TimeWindow",
|
||||
"documentation":"<p>The start date and time and the end date and time of the range for which you want <code>GetSampledRequests</code> to return a sample of requests. Specify the date and time in the following format: <code>\"2016-09-27T14:50Z\"</code>. You can specify any time range in the previous three hours.</p>"
|
||||
"documentation":"<p>The start date and time and the end date and time of the range for which you want <code>GetSampledRequests</code> to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <code>\"2016-09-27T14:50Z\"</code>. You can specify any time range in the previous three hours.</p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"ListMaxItems",
|
||||
|
|
@ -1896,7 +1940,7 @@
|
|||
},
|
||||
"TimeWindow":{
|
||||
"shape":"TimeWindow",
|
||||
"documentation":"<p>Usually, <code>TimeWindow</code> is the time range that you specified in the <code>GetSampledRequests</code> request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, <code>GetSampledRequests</code> returns the time range for the first 5,000 requests.</p>"
|
||||
"documentation":"<p>Usually, <code>TimeWindow</code> is the time range that you specified in the <code>GetSampledRequests</code> request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, <code>GetSampledRequests</code> returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2060,6 +2104,29 @@
|
|||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports any CIDR range. For 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> <p>AWS WAF assigns an ARN to each <code>IPSet</code> that you create. To use an IP set in a rule, you provide the ARN to the <a>Rule</a> statement <a>IPSetReferenceStatement</a>. </p>"
|
||||
},
|
||||
"IPSetForwardedIPConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"HeaderName",
|
||||
"FallbackBehavior",
|
||||
"Position"
|
||||
],
|
||||
"members":{
|
||||
"HeaderName":{
|
||||
"shape":"ForwardedIPHeaderName",
|
||||
"documentation":"<p>The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to <code>X-Forwarded-For</code>.</p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note>"
|
||||
},
|
||||
"FallbackBehavior":{
|
||||
"shape":"FallbackBehavior",
|
||||
"documentation":"<p>The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.</p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note> <p>You can specify the following fallback behaviors:</p> <ul> <li> <p>MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.</p> </li> <li> <p>NO_MATCH - Treat the web request as not matching the rule statement.</p> </li> </ul>"
|
||||
},
|
||||
"Position":{
|
||||
"shape":"ForwardedIPPosition",
|
||||
"documentation":"<p>The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be <code>10.1.1.1, 127.0.0.0, 10.10.10.10</code> where the first IP address identifies the original client and the rest identify proxies that the request went through. </p> <p>The options for this setting are the following: </p> <ul> <li> <p>FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.</p> </li> <li> <p>LAST - Inspect the last IP address in the list of IP addresses in the header.</p> </li> <li> <p>ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. </p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note> <p>This configuration is used only for <a>IPSetReferenceStatement</a>. For <a>GeoMatchStatement</a> and <a>RateBasedStatement</a>, use <a>ForwardedIPConfig</a> instead. </p>"
|
||||
},
|
||||
"IPSetReferenceStatement":{
|
||||
"type":"structure",
|
||||
"required":["ARN"],
|
||||
|
|
@ -2067,6 +2134,10 @@
|
|||
"ARN":{
|
||||
"shape":"ResourceArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the <a>IPSet</a> that this statement references.</p>"
|
||||
},
|
||||
"IPSetForwardedIPConfig":{
|
||||
"shape":"IPSetForwardedIPConfig",
|
||||
"documentation":"<p>The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. </p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an <a>IPSet</a> that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see <a>CreateIPSet</a>.</p> <p>Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.</p>"
|
||||
|
|
@ -2533,7 +2604,12 @@
|
|||
"TAGS",
|
||||
"TAG_KEYS",
|
||||
"METRIC_NAME",
|
||||
"FIREWALL_MANAGER_STATEMENT"
|
||||
"FIREWALL_MANAGER_STATEMENT",
|
||||
"FALLBACK_BEHAVIOR",
|
||||
"POSITION",
|
||||
"FORWARDED_IP_CONFIG",
|
||||
"IP_SET_FORWARDED_IP_CONFIG",
|
||||
"HEADER_NAME"
|
||||
]
|
||||
},
|
||||
"ParameterExceptionParameter":{
|
||||
|
|
@ -2611,22 +2687,29 @@
|
|||
"members":{
|
||||
"Limit":{
|
||||
"shape":"RateLimit",
|
||||
"documentation":"<p>The limit on requests per 5-minute period for a single originating IP address. If the statement includes a <code>ScopDownStatement</code>, this limit is applied only to the requests that match the statement.</p>"
|
||||
"documentation":"<p>The limit on requests per 5-minute period for a single originating IP address. If the statement includes a <code>ScopeDownStatement</code>, this limit is applied only to the requests that match the statement.</p>"
|
||||
},
|
||||
"AggregateKeyType":{
|
||||
"shape":"RateBasedStatementAggregateKeyType",
|
||||
"documentation":"<p>Setting that indicates how to aggregate the request counts. Currently, you must set this to <code>IP</code>. The request counts are aggregated on IP addresses. </p>"
|
||||
"documentation":"<p>Setting that indicates how to aggregate the request counts. The options are the following:</p> <ul> <li> <p>IP - Aggregate the request counts on the IP address from the web request origin.</p> </li> <li> <p>FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the <code>ForwardedIPConfig</code>, to specify the header to use. </p> </li> </ul>"
|
||||
},
|
||||
"ScopeDownStatement":{
|
||||
"shape":"Statement",
|
||||
"documentation":"<p>An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.</p>"
|
||||
},
|
||||
"ForwardedIPConfig":{
|
||||
"shape":"ForwardedIPConfig",
|
||||
"documentation":"<p>The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. </p> <note> <p>If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.</p> </note> <p>This is required if <code>AggregateKeyType</code> is set to <code>FORWARDED_IP</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.</p> <p>When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.</p> <p>You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:</p> <ul> <li> <p>An IP match statement with an IP set that specified the address 192.0.2.44.</p> </li> <li> <p>A string match statement that searches in the User-Agent header for the string BadBot.</p> </li> </ul> <p>In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.</p> <p>You cannot nest a <code>RateBasedStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>. It can only be referenced as a top-level statement within a rule.</p>"
|
||||
},
|
||||
"RateBasedStatementAggregateKeyType":{
|
||||
"type":"string",
|
||||
"enum":["IP"]
|
||||
"enum":[
|
||||
"IP",
|
||||
"FORWARDED_IP"
|
||||
]
|
||||
},
|
||||
"RateBasedStatementManagedKeysIPSet":{
|
||||
"type":"structure",
|
||||
|
|
@ -3125,7 +3208,7 @@
|
|||
"documentation":"<p>Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.</p> <p>You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. </p>"
|
||||
},
|
||||
"TagInfoForResource":{
|
||||
"type":"structure",
|
||||
|
|
@ -3139,7 +3222,7 @@
|
|||
"documentation":"<p>The array of <a>Tag</a> objects defined for the resource. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The collection of tagging definitions for an AWS resource. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>The collection of tagging definitions for an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.</p> <p>You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. </p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
|
|
@ -3232,14 +3315,14 @@
|
|||
"members":{
|
||||
"StartTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>\"2016-09-27T14:50Z\"</code>. You can specify any time range in the previous three hours.</p>"
|
||||
"documentation":"<p>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <code>\"2016-09-27T14:50Z\"</code>. You can specify any time range in the previous three hours.</p>"
|
||||
},
|
||||
"EndTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>\"2016-09-27T14:50Z\"</code>. You can specify any time range in the previous three hours.</p>"
|
||||
"documentation":"<p>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <code>\"2016-09-27T14:50Z\"</code>. You can specify any time range in the previous three hours.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>In a <a>GetSampledRequests</a> request, the <code>StartTime</code> and <code>EndTime</code> objects specify the time range for which you want AWS WAF to return a sample of web requests.</p> <p>In a <a>GetSampledRequests</a> response, the <code>StartTime</code> and <code>EndTime</code> objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, <code>EndTime</code> is the time that AWS WAF received the 5,000th request. </p>"
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>In a <a>GetSampledRequests</a> request, the <code>StartTime</code> and <code>EndTime</code> objects specify the time range for which you want AWS WAF to return a sample of web requests.</p> <p>You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <code>\"2016-09-27T14:50Z\"</code>. You can specify any time range in the previous three hours.</p> <p>In a <a>GetSampledRequests</a> response, the <code>StartTime</code> and <code>EndTime</code> objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, <code>EndTime</code> is the time that AWS WAF received the 5,000th request.</p>"
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"URIString":{"type":"string"},
|
||||
|
|
@ -3488,7 +3571,7 @@
|
|||
},
|
||||
"MetricName":{
|
||||
"shape":"MetricName",
|
||||
"documentation":"<p>A name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\" You can't change a <code>MetricName</code> after you create a <code>VisibilityConfig</code>.</p>"
|
||||
"documentation":"<p>A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\" You can't change a <code>MetricName</code> after you create a <code>VisibilityConfig</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<note> <p>This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href=\"https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html\">AWS WAF Developer Guide</a>. </p> </note> <p>Defines and enables Amazon CloudWatch metrics and web request sample collection. </p>"
|
||||
|
|
|
|||
|
|
@ -83,6 +83,7 @@ class DecodeUtils(object):
|
|||
UINT8_BYTE_FORMAT = '!B'
|
||||
UINT16_BYTE_FORMAT = '!H'
|
||||
UINT32_BYTE_FORMAT = '!I'
|
||||
INT8_BYTE_FORMAT = '!b'
|
||||
INT16_BYTE_FORMAT = '!h'
|
||||
INT32_BYTE_FORMAT = '!i'
|
||||
INT64_BYTE_FORMAT = '!q'
|
||||
|
|
@ -147,6 +148,19 @@ class DecodeUtils(object):
|
|||
value = unpack(DecodeUtils.UINT32_BYTE_FORMAT, data[:4])[0]
|
||||
return value, 4
|
||||
|
||||
@staticmethod
|
||||
def unpack_int8(data):
|
||||
"""Parse a signed 8-bit integer from the bytes.
|
||||
|
||||
:type data: bytes
|
||||
:param data: The bytes to parse from.
|
||||
|
||||
:rtype: (int, int)
|
||||
:returns: A tuple containing the (parsed integer value, bytes consumed)
|
||||
"""
|
||||
value = unpack(DecodeUtils.INT8_BYTE_FORMAT, data[:1])[0]
|
||||
return value, 1
|
||||
|
||||
@staticmethod
|
||||
def unpack_int16(data):
|
||||
"""Parse a signed 16-bit integer from the bytes.
|
||||
|
|
@ -349,7 +363,7 @@ class EventStreamHeaderParser(object):
|
|||
# boolean_false
|
||||
1: DecodeUtils.unpack_false,
|
||||
# byte
|
||||
2: DecodeUtils.unpack_uint8,
|
||||
2: DecodeUtils.unpack_int8,
|
||||
# short
|
||||
3: DecodeUtils.unpack_int16,
|
||||
# integer
|
||||
|
|
|
|||
|
|
@ -1049,12 +1049,22 @@ BUILTIN_HANDLERS = [
|
|||
('before-call.neptune.CreateDBCluster',
|
||||
inject_presigned_url_rds),
|
||||
|
||||
# RDS PresignedUrl documentation customizations
|
||||
# Neptune PresignedUrl documentation customizations
|
||||
('docs.*.neptune.CopyDBClusterSnapshot.complete-section',
|
||||
AutoPopulatedParam('PreSignedUrl').document_auto_populated_param),
|
||||
('docs.*.neptune.CreateDBCluster.complete-section',
|
||||
AutoPopulatedParam('PreSignedUrl').document_auto_populated_param),
|
||||
|
||||
#############
|
||||
# DocDB
|
||||
#############
|
||||
('before-call.docdb.CopyDBClusterSnapshot',
|
||||
inject_presigned_url_rds),
|
||||
|
||||
# DocDB PresignedUrl documentation customizations
|
||||
('docs.*.docdb.CopyDBClusterSnapshot.complete-section',
|
||||
AutoPopulatedParam('PreSignedUrl').document_auto_populated_param),
|
||||
|
||||
#############
|
||||
# S3 Control
|
||||
#############
|
||||
|
|
|
|||
|
|
@ -52,9 +52,9 @@ copyright = u'2013, Mitch Garnaat'
|
|||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '1.17'
|
||||
version = '1.17.'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.17.9'
|
||||
release = '1.17.22'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
|
|||
49
tests/functional/test_docdb.py
Normal file
49
tests/functional/test_docdb.py
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"). You
|
||||
# may not use this file except in compliance with the License. A copy of
|
||||
# the License is located at
|
||||
#
|
||||
# http://aws.amazon.com/apache2.0/
|
||||
#
|
||||
# or in the "license" file accompanying this file. This file is
|
||||
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
|
||||
# ANY KIND, either express or implied. See the License for the specific
|
||||
# language governing permissions and limitations under the License.
|
||||
import mock
|
||||
from contextlib import contextmanager
|
||||
|
||||
import botocore.session
|
||||
from tests import BaseSessionTest, ClientHTTPStubber
|
||||
from botocore.stub import Stubber
|
||||
from tests import unittest
|
||||
|
||||
|
||||
class TestDocDBPresignUrlInjection(BaseSessionTest):
|
||||
|
||||
def setUp(self):
|
||||
super(TestDocDBPresignUrlInjection, self).setUp()
|
||||
self.client = self.session.create_client('docdb', 'us-west-2')
|
||||
self.http_stubber = ClientHTTPStubber(self.client)
|
||||
|
||||
def assert_presigned_url_injected_in_request(self, body):
|
||||
self.assertIn('PreSignedUrl', body)
|
||||
self.assertNotIn('SourceRegion', body)
|
||||
|
||||
def test_copy_db_cluster_snapshot(self):
|
||||
params = {
|
||||
'SourceDBClusterSnapshotIdentifier': 'source-db',
|
||||
'TargetDBClusterSnapshotIdentifier': 'target-db',
|
||||
'SourceRegion': 'us-east-1'
|
||||
}
|
||||
response_body = (
|
||||
b'<CopyDBClusterSnapshotResponse>'
|
||||
b'<CopyDBClusterSnapshotResult>'
|
||||
b'</CopyDBClusterSnapshotResult>'
|
||||
b'</CopyDBClusterSnapshotResponse>'
|
||||
)
|
||||
self.http_stubber.add_response(body=response_body)
|
||||
with self.http_stubber:
|
||||
self.client.copy_db_cluster_snapshot(**params)
|
||||
sent_request = self.http_stubber.requests[0]
|
||||
self.assert_presigned_url_injected_in_request(sent_request.body)
|
||||
|
|
@ -38,18 +38,71 @@ EMPTY_MESSAGE = (
|
|||
)
|
||||
)
|
||||
|
||||
INT32_HEADER = (
|
||||
(b"\x00\x00\x00+\x00\x00\x00\x0e4\x8b\xec{\x08event-id\x04\x00\x00\xa0\x0c"
|
||||
b"{'foo':'bar'}\xd3\x89\x02\x85"),
|
||||
INT8_HEADER = (
|
||||
(
|
||||
b"\x00\x00\x00\x17\x00\x00\x00\x07)\x86\x01X\x04"
|
||||
b"byte\x02\xff\xc2\xf8i\xdc"
|
||||
),
|
||||
EventStreamMessage(
|
||||
prelude=MessagePrelude(
|
||||
total_length=0x2b,
|
||||
headers_length=0x0e,
|
||||
crc=0x348bec7b,
|
||||
total_length=0x17,
|
||||
headers_length=0x7,
|
||||
crc=0x29860158,
|
||||
),
|
||||
headers={'event-id': 0x0000a00c},
|
||||
payload=b"{'foo':'bar'}",
|
||||
crc=0xd3890285,
|
||||
headers={'byte': -1},
|
||||
payload=b'',
|
||||
crc=0xc2f869dc,
|
||||
)
|
||||
)
|
||||
|
||||
INT16_HEADER = (
|
||||
(
|
||||
b"\x00\x00\x00\x19\x00\x00\x00\tq\x0e\x92>\x05"
|
||||
b"short\x03\xff\xff\xb2|\xb6\xcc"
|
||||
),
|
||||
EventStreamMessage(
|
||||
prelude=MessagePrelude(
|
||||
total_length=0x19,
|
||||
headers_length=0x9,
|
||||
crc=0x710e923e,
|
||||
),
|
||||
headers={'short': -1},
|
||||
payload=b'',
|
||||
crc=0xb27cb6cc,
|
||||
)
|
||||
)
|
||||
|
||||
INT32_HEADER = (
|
||||
(
|
||||
b"\x00\x00\x00\x1d\x00\x00\x00\r\x83\xe3\xf0\xe7\x07"
|
||||
b"integer\x04\xff\xff\xff\xff\x8b\x8e\x12\xeb"
|
||||
),
|
||||
EventStreamMessage(
|
||||
prelude=MessagePrelude(
|
||||
total_length=0x1D,
|
||||
headers_length=0xD,
|
||||
crc=0x83e3f0e7,
|
||||
),
|
||||
headers={'integer': -1},
|
||||
payload=b'',
|
||||
crc=0x8b8e12eb,
|
||||
)
|
||||
)
|
||||
|
||||
INT64_HEADER = (
|
||||
(
|
||||
b"\x00\x00\x00\x1e\x00\x00\x00\x0e]J\xdb\x8d\x04"
|
||||
b"long\x05\xff\xff\xff\xff\xff\xff\xff\xffK\xc22\xda"
|
||||
),
|
||||
EventStreamMessage(
|
||||
prelude=MessagePrelude(
|
||||
total_length=0x1E,
|
||||
headers_length=0xE,
|
||||
crc=0x5d4adb8d,
|
||||
),
|
||||
headers={'long': -1},
|
||||
payload=b'',
|
||||
crc=0x4bc232da,
|
||||
)
|
||||
)
|
||||
|
||||
|
|
@ -137,7 +190,10 @@ ERROR_EVENT_MESSAGE = (
|
|||
# Tuples of encoded messages and their expected decoded output
|
||||
POSITIVE_CASES = [
|
||||
EMPTY_MESSAGE,
|
||||
INT8_HEADER,
|
||||
INT16_HEADER,
|
||||
INT32_HEADER,
|
||||
INT64_HEADER,
|
||||
PAYLOAD_NO_HEADERS,
|
||||
PAYLOAD_ONE_STR_HEADER,
|
||||
ALL_HEADERS_TYPES,
|
||||
|
|
@ -286,9 +342,10 @@ def test_message_prelude_properties():
|
|||
|
||||
|
||||
def test_message_to_response_dict():
|
||||
response_dict = INT32_HEADER[1].to_response_dict()
|
||||
response_dict = PAYLOAD_ONE_STR_HEADER[1].to_response_dict()
|
||||
assert_equal(response_dict['status_code'], 200)
|
||||
assert_equal(response_dict['headers'], {'event-id': 0x0000a00c})
|
||||
expected_headers = {'content-type': 'application/json'}
|
||||
assert_equal(response_dict['headers'], expected_headers)
|
||||
assert_equal(response_dict['body'], b"{'foo':'bar'}")
|
||||
|
||||
|
||||
|
|
@ -316,6 +373,12 @@ def test_unpack_uint32():
|
|||
assert_equal(value, 0xDEADBEEF)
|
||||
|
||||
|
||||
def test_unpack_int8():
|
||||
(value, bytes_consumed) = DecodeUtils.unpack_int8(b'\xFE')
|
||||
assert_equal(bytes_consumed, 1)
|
||||
assert_equal(value, -2)
|
||||
|
||||
|
||||
def test_unpack_int16():
|
||||
(value, bytes_consumed) = DecodeUtils.unpack_int16(b'\xFF\xFE')
|
||||
assert_equal(bytes_consumed, 2)
|
||||
|
|
|
|||
Loading…
Reference in a new issue