extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-08-20 01:58:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

vendor: update all dependencies to latest versions

Browse Source
This commit is contained in:
Nick Craig-Wood
2017-09-30 15:27:27 +01:00
parent 911d121bb9
commit b017fcfe9a
3048 changed files with 537057 additions and 189681 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3587
vendor/github.com/aws/aws-sdk-go/models/apis/AWS Glue/2017-03-31/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

2474
vendor/github.com/aws/aws-sdk-go/models/apis/AWS Glue/2017-03-31/docs-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

5
vendor/github.com/aws/aws-sdk-go/models/apis/AWS Glue/2017-03-31/examples-1.json generated vendored Normal file
View File

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

69
vendor/github.com/aws/aws-sdk-go/models/apis/AWS Glue/2017-03-31/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,69 @@
{
"pagination": {
"GetClassifiers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetConnections": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetCrawlerMetrics": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetCrawlers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetDatabases": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetDevEndpoints": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetJobRuns": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetJobs": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetPartitions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetTableVersions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetTables": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetTriggers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetUserDefinedFunctions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

551
vendor/github.com/aws/aws-sdk-go/models/apis/MobileHub/2017-07-01/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,551 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-07-01",
"endpointPrefix":"mobile",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS Mobile",
"signatureVersion":"v4",
"signingName":"AWSMobileHubService",
"uid":"mobile-2017-07-01"
},
"operations":{
"CreateProject":{
"name":"CreateProject",
"http":{
"method":"POST",
"requestUri":"/projects"
},
"input":{"shape":"CreateProjectRequest"},
"output":{"shape":"CreateProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"}
]
},
"DeleteProject":{
"name":"DeleteProject",
"http":{
"method":"DELETE",
"requestUri":"/projects/{projectId}"
},
"input":{"shape":"DeleteProjectRequest"},
"output":{"shape":"DeleteProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"}
]
},
"DescribeBundle":{
"name":"DescribeBundle",
"http":{
"method":"GET",
"requestUri":"/bundles/{bundleId}"
},
"input":{"shape":"DescribeBundleRequest"},
"output":{"shape":"DescribeBundleResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
]
},
"DescribeProject":{
"name":"DescribeProject",
"http":{
"method":"GET",
"requestUri":"/project"
},
"input":{"shape":"DescribeProjectRequest"},
"output":{"shape":"DescribeProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
]
},
"ExportBundle":{
"name":"ExportBundle",
"http":{
"method":"POST",
"requestUri":"/bundles/{bundleId}"
},
"input":{"shape":"ExportBundleRequest"},
"output":{"shape":"ExportBundleResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
]
},
"ExportProject":{
"name":"ExportProject",
"http":{
"method":"POST",
"requestUri":"/exports/{projectId}"
},
"input":{"shape":"ExportProjectRequest"},
"output":{"shape":"ExportProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
]
},
"ListBundles":{
"name":"ListBundles",
"http":{
"method":"GET",
"requestUri":"/bundles"
},
"input":{"shape":"ListBundlesRequest"},
"output":{"shape":"ListBundlesResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
]
},
"ListProjects":{
"name":"ListProjects",
"http":{
"method":"GET",
"requestUri":"/projects"
},
"input":{"shape":"ListProjectsRequest"},
"output":{"shape":"ListProjectsResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
]
},
"UpdateProject":{
"name":"UpdateProject",
"http":{
"method":"POST",
"requestUri":"/update"
},
"input":{"shape":"UpdateProjectRequest"},
"output":{"shape":"UpdateProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"},
{"shape":"AccountActionRequiredException"},
{"shape":"LimitExceededException"}
]
}
},
"shapes":{
"AccountActionRequiredException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":403},
"exception":true
},
"AttributeKey":{"type":"string"},
"AttributeValue":{"type":"string"},
"Attributes":{
"type":"map",
"key":{"shape":"AttributeKey"},
"value":{"shape":"AttributeValue"}
},
"BadRequestException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"Boolean":{"type":"boolean"},
"BundleDescription":{"type":"string"},
"BundleDetails":{
"type":"structure",
"members":{
"bundleId":{"shape":"BundleId"},
"title":{"shape":"BundleTitle"},
"version":{"shape":"BundleVersion"},
"description":{"shape":"BundleDescription"},
"iconUrl":{"shape":"IconUrl"},
"availablePlatforms":{"shape":"Platforms"}
}
},
"BundleId":{"type":"string"},
"BundleList":{
"type":"list",
"member":{"shape":"BundleDetails"}
},
"BundleTitle":{"type":"string"},
"BundleVersion":{"type":"string"},
"ConsoleUrl":{"type":"string"},
"Contents":{"type":"blob"},
"CreateProjectRequest":{
"type":"structure",
"members":{
"name":{
"shape":"ProjectName",
"location":"querystring",
"locationName":"name"
},
"region":{
"shape":"ProjectRegion",
"location":"querystring",
"locationName":"region"
},
"contents":{"shape":"Contents"},
"snapshotId":{
"shape":"SnapshotId",
"location":"querystring",
"locationName":"snapshotId"
}
},
"payload":"contents"
},
"CreateProjectResult":{
"type":"structure",
"members":{
"details":{"shape":"ProjectDetails"}
}
},
"Date":{"type":"timestamp"},
"DeleteProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"projectId":{
"shape":"ProjectId",
"location":"uri",
"locationName":"projectId"
}
}
},
"DeleteProjectResult":{
"type":"structure",
"members":{
"deletedResources":{"shape":"Resources"},
"orphanedResources":{"shape":"Resources"}
}
},
"DescribeBundleRequest":{
"type":"structure",
"required":["bundleId"],
"members":{
"bundleId":{
"shape":"BundleId",
"location":"uri",
"locationName":"bundleId"
}
}
},
"DescribeBundleResult":{
"type":"structure",
"members":{
"details":{"shape":"BundleDetails"}
}
},
"DescribeProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"projectId":{
"shape":"ProjectId",
"location":"querystring",
"locationName":"projectId"
},
"syncFromResources":{
"shape":"Boolean",
"location":"querystring",
"locationName":"syncFromResources"
}
}
},
"DescribeProjectResult":{
"type":"structure",
"members":{
"details":{"shape":"ProjectDetails"}
}
},
"DownloadUrl":{"type":"string"},
"ErrorMessage":{"type":"string"},
"ExportBundleRequest":{
"type":"structure",
"required":["bundleId"],
"members":{
"bundleId":{
"shape":"BundleId",
"location":"uri",
"locationName":"bundleId"
},
"projectId":{
"shape":"ProjectId",
"location":"querystring",
"locationName":"projectId"
},
"platform":{
"shape":"Platform",
"location":"querystring",
"locationName":"platform"
}
}
},
"ExportBundleResult":{
"type":"structure",
"members":{
"downloadUrl":{"shape":"DownloadUrl"}
}
},
"ExportProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"projectId":{
"shape":"ProjectId",
"location":"uri",
"locationName":"projectId"
}
}
},
"ExportProjectResult":{
"type":"structure",
"members":{
"downloadUrl":{"shape":"DownloadUrl"},
"shareUrl":{"shape":"ShareUrl"},
"snapshotId":{"shape":"SnapshotId"}
}
},
"Feature":{"type":"string"},
"IconUrl":{"type":"string"},
"InternalFailureException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"retryAfterSeconds":{
"shape":"ErrorMessage",
"location":"header",
"locationName":"Retry-After"
},
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":429},
"exception":true
},
"ListBundlesRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListBundlesResult":{
"type":"structure",
"members":{
"bundleList":{"shape":"BundleList"},
"nextToken":{"shape":"NextToken"}
}
},
"ListProjectsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListProjectsResult":{
"type":"structure",
"members":{
"projects":{"shape":"ProjectSummaries"},
"nextToken":{"shape":"NextToken"}
}
},
"MaxResults":{"type":"integer"},
"NextToken":{"type":"string"},
"NotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":404},
"exception":true
},
"Platform":{
"type":"string",
"enum":[
"OSX",
"WINDOWS",
"LINUX",
"OBJC",
"SWIFT",
"ANDROID",
"JAVASCRIPT"
]
},
"Platforms":{
"type":"list",
"member":{"shape":"Platform"}
},
"ProjectDetails":{
"type":"structure",
"members":{
"name":{"shape":"ProjectName"},
"projectId":{"shape":"ProjectId"},
"region":{"shape":"ProjectRegion"},
"state":{"shape":"ProjectState"},
"createdDate":{"shape":"Date"},
"lastUpdatedDate":{"shape":"Date"},
"consoleUrl":{"shape":"ConsoleUrl"},
"resources":{"shape":"Resources"}
}
},
"ProjectId":{"type":"string"},
"ProjectName":{"type":"string"},
"ProjectRegion":{"type":"string"},
"ProjectState":{
"type":"string",
"enum":[
"NORMAL",
"SYNCING",
"IMPORTING"
]
},
"ProjectSummaries":{
"type":"list",
"member":{"shape":"ProjectSummary"}
},
"ProjectSummary":{
"type":"structure",
"members":{
"name":{"shape":"ProjectName"},
"projectId":{"shape":"ProjectId"}
}
},
"Resource":{
"type":"structure",
"members":{
"type":{"shape":"ResourceType"},
"name":{"shape":"ResourceName"},
"arn":{"shape":"ResourceArn"},
"feature":{"shape":"Feature"},
"attributes":{"shape":"Attributes"}
}
},
"ResourceArn":{"type":"string"},
"ResourceName":{"type":"string"},
"ResourceType":{"type":"string"},
"Resources":{
"type":"list",
"member":{"shape":"Resource"}
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"retryAfterSeconds":{
"shape":"ErrorMessage",
"location":"header",
"locationName":"Retry-After"
},
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":503},
"exception":true,
"fault":true
},
"ShareUrl":{"type":"string"},
"SnapshotId":{"type":"string"},
"TooManyRequestsException":{
"type":"structure",
"members":{
"retryAfterSeconds":{
"shape":"ErrorMessage",
"location":"header",
"locationName":"Retry-After"
},
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":429},
"exception":true
},
"UnauthorizedException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"error":{"httpStatusCode":401},
"exception":true
},
"UpdateProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"contents":{"shape":"Contents"},
"projectId":{
"shape":"ProjectId",
"location":"querystring",
"locationName":"projectId"
}
},
"payload":"contents"
},
"UpdateProjectResult":{
"type":"structure",
"members":{
"details":{"shape":"ProjectDetails"}
}
}
}
}

392
vendor/github.com/aws/aws-sdk-go/models/apis/MobileHub/2017-07-01/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,392 @@
{
"version": "2.0",
"service": "<p> AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources. </p>",
"operations": {
"CreateProject": "<p> Creates an AWS Mobile Hub project. </p>",
"DeleteProject": "<p> Delets a project in AWS Mobile Hub. </p>",
"DescribeBundle": "<p> Get the bundle details for the requested bundle id. </p>",
"DescribeProject": "<p> Gets details about a project in AWS Mobile Hub. </p>",
"ExportBundle": "<p> Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources. </p>",
"ExportProject": "<p> Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account. </p>",
"ListBundles": "<p> List all available bundles. </p>",
"ListProjects": "<p> Lists projects in AWS Mobile Hub. </p>",
"UpdateProject": "<p> Update an existing project. </p>"
},
"shapes": {
"AccountActionRequiredException": {
"base": "<p> Account Action is required in order to continue the request. </p>",
"refs": {
}
},
"AttributeKey": {
"base": "<p> Key part of key-value attribute pairs. </p>",
"refs": {
"Attributes$key": null
}
},
"AttributeValue": {
"base": "<p> Value part of key-value attribute pairs. </p>",
"refs": {
"Attributes$value": null
}
},
"Attributes": {
"base": "<p> Key-value attribute pairs. </p>",
"refs": {
"Resource$attributes": null
}
},
"BadRequestException": {
"base": "<p> The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed. </p>",
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"DescribeProjectRequest$syncFromResources": "<p> If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project. </p>"
}
},
"BundleDescription": {
"base": "<p> Description of the download bundle. </p>",
"refs": {
"BundleDetails$description": null
}
},
"BundleDetails": {
"base": "<p> The details of the bundle. </p>",
"refs": {
"BundleList$member": null,
"DescribeBundleResult$details": "<p> The details of the bundle. </p>"
}
},
"BundleId": {
"base": "<p> Unique bundle identifier. </p>",
"refs": {
"BundleDetails$bundleId": null,
"DescribeBundleRequest$bundleId": "<p> Unique bundle identifier. </p>",
"ExportBundleRequest$bundleId": "<p> Unique bundle identifier. </p>"
}
},
"BundleList": {
"base": "<p> A list of bundles. </p>",
"refs": {
"ListBundlesResult$bundleList": "<p> A list of bundles. </p>"
}
},
"BundleTitle": {
"base": "<p> Title of the download bundle. </p>",
"refs": {
"BundleDetails$title": null
}
},
"BundleVersion": {
"base": "<p> Version of the download bundle. </p>",
"refs": {
"BundleDetails$version": null
}
},
"ConsoleUrl": {
"base": null,
"refs": {
"ProjectDetails$consoleUrl": "<p> Website URL for this project in the AWS Mobile Hub console. </p>"
}
},
"Contents": {
"base": "<p> Binary file data. </p>",
"refs": {
"CreateProjectRequest$contents": "<p> ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the contents of the file downloaded from the URL provided in an export project operation. </p>",
"UpdateProjectRequest$contents": "<p> ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file downloaded from the URL provided in an export project operation. </p>"
}
},
"CreateProjectRequest": {
"base": "<p> Request structure used to request a project be created. </p>",
"refs": {
}
},
"CreateProjectResult": {
"base": "<p> Result structure used in response to a request to create a project. </p>",
"refs": {
}
},
"Date": {
"base": null,
"refs": {
"ProjectDetails$createdDate": "<p> Date the project was created. </p>",
"ProjectDetails$lastUpdatedDate": "<p> Date of the last modification of the project. </p>"
}
},
"DeleteProjectRequest": {
"base": "<p> Request structure used to request a project be deleted. </p>",
"refs": {
}
},
"DeleteProjectResult": {
"base": "<p> Result structure used in response to request to delete a project. </p>",
"refs": {
}
},
"DescribeBundleRequest": {
"base": "<p> Request structure to request the details of a specific bundle. </p>",
"refs": {
}
},
"DescribeBundleResult": {
"base": "<p> Result structure contains the details of the bundle. </p>",
"refs": {
}
},
"DescribeProjectRequest": {
"base": "<p> Request structure used to request details about a project. </p>",
"refs": {
}
},
"DescribeProjectResult": {
"base": "<p> Result structure used for requests of project details. </p>",
"refs": {
}
},
"DownloadUrl": {
"base": "<p> The download Url. </p>",
"refs": {
"ExportBundleResult$downloadUrl": "<p> URL which contains the custom-generated SDK and tool packages used to integrate the client mobile app or web app with the AWS resources created by the AWS Mobile Hub project. </p>",
"ExportProjectResult$downloadUrl": "<p> URL which can be used to download the exported project configuation file(s). </p>"
}
},
"ErrorMessage": {
"base": "<p> The Exception Error Message. </p>",
"refs": {
"AccountActionRequiredException$message": null,
"BadRequestException$message": null,
"InternalFailureException$message": null,
"LimitExceededException$retryAfterSeconds": null,
"LimitExceededException$message": null,
"NotFoundException$message": null,
"ServiceUnavailableException$retryAfterSeconds": null,
"ServiceUnavailableException$message": null,
"TooManyRequestsException$retryAfterSeconds": null,
"TooManyRequestsException$message": null,
"UnauthorizedException$message": null
}
},
"ExportBundleRequest": {
"base": "<p> Request structure used to request generation of custom SDK and tool packages required to integrate mobile web or app clients with backed AWS resources. </p>",
"refs": {
}
},
"ExportBundleResult": {
"base": "<p> Result structure which contains link to download custom-generated SDK and tool packages used to integrate mobile web or app clients with backed AWS resources. </p>",
"refs": {
}
},
"ExportProjectRequest": {
"base": "<p> Request structure used in requests to export project configuration details. </p>",
"refs": {
}
},
"ExportProjectResult": {
"base": "<p> Result structure used for requests to export project configuration details. </p>",
"refs": {
}
},
"Feature": {
"base": "<p> Identifies which feature in AWS Mobile Hub is associated with this AWS resource. </p>",
"refs": {
"Resource$feature": null
}
},
"IconUrl": {
"base": "<p> Icon for the download bundle. </p>",
"refs": {
"BundleDetails$iconUrl": null
}
},
"InternalFailureException": {
"base": "<p> The service has encountered an unexpected error condition which prevents it from servicing the request. </p>",
"refs": {
}
},
"LimitExceededException": {
"base": "<p> There are too many AWS Mobile Hub projects in the account or the account has exceeded the maximum number of resources in some AWS service. You should create another sub-account using AWS Organizations or remove some resources and retry your request. </p>",
"refs": {
}
},
"ListBundlesRequest": {
"base": "<p> Request structure to request all available bundles. </p>",
"refs": {
}
},
"ListBundlesResult": {
"base": "<p> Result structure contains a list of all available bundles with details. </p>",
"refs": {
}
},
"ListProjectsRequest": {
"base": "<p> Request structure used to request projects list in AWS Mobile Hub. </p>",
"refs": {
}
},
"ListProjectsResult": {
"base": "<p> Result structure used for requests to list projects in AWS Mobile Hub. </p>",
"refs": {
}
},
"MaxResults": {
"base": "<p> Maximum number of records to list in a single response. </p>",
"refs": {
"ListBundlesRequest$maxResults": "<p> Maximum number of records to list in a single response. </p>",
"ListProjectsRequest$maxResults": "<p> Maximum number of records to list in a single response. </p>"
}
},
"NextToken": {
"base": "<p> Pagination token. Set to null to start listing records from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more entries. </p>",
"refs": {
"ListBundlesRequest$nextToken": "<p> Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more bundles. </p>",
"ListBundlesResult$nextToken": "<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>",
"ListProjectsRequest$nextToken": "<p> Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more projects. </p>",
"ListProjectsResult$nextToken": null
}
},
"NotFoundException": {
"base": "<p> No entity can be found with the specified identifier. </p>",
"refs": {
}
},
"Platform": {
"base": "<p> Developer desktop or target mobile app or website platform. </p>",
"refs": {
"ExportBundleRequest$platform": "<p> Developer desktop or target application platform. </p>",
"Platforms$member": null
}
},
"Platforms": {
"base": "<p> Developer desktop or mobile app or website platforms. </p>",
"refs": {
"BundleDetails$availablePlatforms": null
}
},
"ProjectDetails": {
"base": "<p> Detailed information about an AWS Mobile Hub project. </p>",
"refs": {
"CreateProjectResult$details": "<p> Detailed information about the created AWS Mobile Hub project. </p>",
"DescribeProjectResult$details": null,
"UpdateProjectResult$details": "<p> Detailed information about the updated AWS Mobile Hub project. </p>"
}
},
"ProjectId": {
"base": "<p> Unique project identifier. </p>",
"refs": {
"DeleteProjectRequest$projectId": "<p> Unique project identifier. </p>",
"DescribeProjectRequest$projectId": "<p> Unique project identifier. </p>",
"ExportBundleRequest$projectId": "<p> Unique project identifier. </p>",
"ExportProjectRequest$projectId": "<p> Unique project identifier. </p>",
"ProjectDetails$projectId": null,
"ProjectSummary$projectId": "<p> Unique project identifier. </p>",
"UpdateProjectRequest$projectId": "<p> Unique project identifier. </p>"
}
},
"ProjectName": {
"base": "<p> Name of the project. </p>",
"refs": {
"CreateProjectRequest$name": "<p> Name of the project. </p>",
"ProjectDetails$name": null,
"ProjectSummary$name": "<p> Name of the project. </p>"
}
},
"ProjectRegion": {
"base": "<p> Default region to use for AWS resource creation in the AWS Mobile Hub project. </p>",
"refs": {
"CreateProjectRequest$region": "<p> Default region where project resources should be created. </p>",
"ProjectDetails$region": null
}
},
"ProjectState": {
"base": "<p> Synchronization state for a project. </p>",
"refs": {
"ProjectDetails$state": null
}
},
"ProjectSummaries": {
"base": "<p> List of projects. </p>",
"refs": {
"ListProjectsResult$projects": null
}
},
"ProjectSummary": {
"base": "<p> Summary information about an AWS Mobile Hub project. </p>",
"refs": {
"ProjectSummaries$member": null
}
},
"Resource": {
"base": "<p> Information about an instance of an AWS resource associated with a project. </p>",
"refs": {
"Resources$member": null
}
},
"ResourceArn": {
"base": "<p> AWS resource name which uniquely identifies the resource in AWS systems. </p>",
"refs": {
"Resource$arn": null
}
},
"ResourceName": {
"base": "<p> Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket). </p>",
"refs": {
"Resource$name": null
}
},
"ResourceType": {
"base": "<p> Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket). </p>",
"refs": {
"Resource$type": null
}
},
"Resources": {
"base": "<p> List of AWS resources associated with a project. </p>",
"refs": {
"DeleteProjectResult$deletedResources": "<p> Resources which were deleted. </p>",
"DeleteProjectResult$orphanedResources": "<p> Resources which were not deleted, due to a risk of losing potentially important data or files. </p>",
"ProjectDetails$resources": null
}
},
"ServiceUnavailableException": {
"base": "<p> The service is temporarily unavailable. The request should be retried after some time delay. </p>",
"refs": {
}
},
"ShareUrl": {
"base": "<p> URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again. </p>",
"refs": {
"ExportProjectResult$shareUrl": "<p> URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again. </p>"
}
},
"SnapshotId": {
"base": "<p> Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL. </p>",
"refs": {
"CreateProjectRequest$snapshotId": "<p> Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported. </p>",
"ExportProjectResult$snapshotId": "<p> Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL. </p>"
}
},
"TooManyRequestsException": {
"base": "<p> Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay. </p>",
"refs": {
}
},
"UnauthorizedException": {
"base": "<p> Credentials of the caller are insufficient to authorize the request. </p>",
"refs": {
}
},
"UpdateProjectRequest": {
"base": "<p> Request structure used for requests to update project configuration. </p>",
"refs": {
}
},
"UpdateProjectResult": {
"base": "<p> Result structure used for requests to updated project configuration. </p>",
"refs": {
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/MobileHub/2017-07-01/examples-1.json generated vendored Normal file
View File

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

14
vendor/github.com/aws/aws-sdk-go/models/apis/MobileHub/2017-07-01/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,14 @@
{
"pagination": {
"ListBundles": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListProjects": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
}
}
}

6
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/api-2.json generated vendored
View File

@@ -295,6 +295,8 @@
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"NotFoundException"},
{"shape":"ConflictException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"}
]
},
@@ -1823,6 +1825,7 @@
"type":"string",
"enum":[
"TOKEN",
"REQUEST",
"COGNITO_USER_POOLS"
]
},
@@ -1939,8 +1942,7 @@
"required":[
"restApiId",
"name",
"type",
"identitySource"
"type"
],
"members":{
"restApiId":{

60
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/docs-2.json generated vendored
View File

@@ -156,10 +156,10 @@
}
},
"AuthorizerType": {
"base": "<p>The authorizer type. the current value is <code>TOKEN</code> for a Lambda function or <code>COGNITO_USER_POOLS</code> for an Amazon Cognito Your User Pool.</p>",
"base": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"refs": {
"Authorizer$type": "<p>[Required] The type of the authorizer. Currently, the valid type is <code>TOKEN</code> for a Lambda function or <code>COGNITO_USER_POOLS</code> for an Amazon Cognito user pool.</p>",
"CreateAuthorizerRequest$type": "<p>[Required] The type of the authorizer.</p>"
"Authorizer$type": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"CreateAuthorizerRequest$type": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>"
}
},
"Authorizers": {
@@ -168,7 +168,7 @@
}
},
"BadRequestException": {
"base": null,
"base": "<p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>",
"refs": {
}
},
@@ -237,7 +237,7 @@
}
},
"ClientCertificate": {
"base": "<p>Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.</p> <div class=\"remarks\">Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom <a>Authorizer</a>.</div> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html\">Use Client-Side Certificate</a> </div>",
"base": "<p>Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.</p> <div class=\"remarks\">Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom <a>Authorizer</a> or an Amazon Cognito user pool.</div> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.html\">Use Client-Side Certificate</a> </div>",
"refs": {
"ListOfClientCertificate$member": null
}
@@ -248,7 +248,7 @@
}
},
"ConflictException": {
"base": null,
"base": "<p>The request configuration has conflicts. For details, see the accompanying error message.</p>",
"refs": {
}
},
@@ -469,7 +469,7 @@
"DocumentationPartType": {
"base": null,
"refs": {
"DocumentationPartLocation$type": "<p>The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHROZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>",
"DocumentationPartLocation$type": "<p>The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>",
"GetDocumentationPartsRequest$type": "<p>The type of API entities of the to-be-retrieved documentation parts. </p>"
}
},
@@ -810,15 +810,15 @@
}
},
"LimitExceededException": {
"base": null,
"base": "<p>The request exceeded the rate limit. Retry after the specified time period.</p>",
"refs": {
}
},
"ListOfARNs": {
"base": null,
"refs": {
"Authorizer$providerARNs": "<p>A list of the provider ARNs of the authorizer. For an <code>TOKEN</code> authorizer, this is not defined. For authorizers of the <code>COGNITO_USER_POOLS</code> type, each element corresponds to a user pool ARN of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. </p>",
"CreateAuthorizerRequest$providerARNs": "<p>A list of the Cognito Your User Pool authorizer's provider ARNs.</p>"
"Authorizer$providerARNs": "<p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>",
"CreateAuthorizerRequest$providerARNs": "<p>A list of the Amazon Cognito user pool ARNs for the <code>COGNITO_USER_POOLS</code> authorizer. Each element is of this format: <code>arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}</code>. For a <code>TOKEN</code> or <code>REQUEST</code> authorizer, this is not defined. </p>"
}
},
"ListOfApiKey": {
@@ -1076,7 +1076,7 @@
"GatewayResponse$responseParameters": "<p>Response parameters (paths, query strings and headers) of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p>",
"GatewayResponse$responseTemplates": "<p>Response templates of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p>",
"GetExportRequest$parameters": "<p>A key-value map of query string parameters that specify properties of the export, depending on the requested <code>exportType</code>. For <code>exportType</code> <code>swagger</code>, any combination of the following parameters are supported: <code>integrations</code> will export the API with x-amazon-apigateway-integration extensions. <code>authorizers</code> will export the API with x-amazon-apigateway-authorizer extensions. <code>postman</code> will export the API with Postman extensions, allowing for import to the Postman tool</p>",
"GetSdkRequest$parameters": "<p>A key-value map of query string parameters that specify properties of the SDK, depending on the requested <code>sdkType</code>. For <code>sdkType</code> of <code>objectivec</code>, a parameter named <code>classPrefix</code> is required. For <code>sdkType</code> of <code>android</code>, parameters named <code>groupId</code>, <code>artifactId</code>, <code>artifactVersion</code>, and <code>invokerPackage</code> are required.</p>",
"GetSdkRequest$parameters": "<p>A string-to-string key-value map of query parameters <code>sdkType</code>-dependent properties of the SDK. For <code>sdkType</code> of <code>objectivec</code> or <code>swift</code>, a parameter named <code>classPrefix</code> is required. For <code>sdkType</code> of <code>android</code>, parameters named <code>groupId</code>, <code>artifactId</code>, <code>artifactVersion</code>, and <code>invokerPackage</code> are required. For <code>sdkType</code> of <code>java</code>, parameters named <code>serviceName</code> and <code>javaPackageName</code> are required. </p>",
"ImportRestApiRequest$parameters": "<p>Custom header parameters as part of the request. For example, to exclude <a>DocumentationParts</a> from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json</code>.</p>",
"Integration$requestParameters": "<p>A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of <code>method.request.{location}.{name}</code>, where <code>location</code> is <code>querystring</code>, <code>path</code>, or <code>header</code> and <code>name</code> must be a valid and unique method request parameter name.</p>",
"Integration$requestTemplates": "<p>Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.</p>",
@@ -1136,7 +1136,7 @@
}
},
"NotFoundException": {
"base": null,
"base": "<p>The requested resource is not found. Make sure that the request URI is correct.</p>",
"refs": {
}
},
@@ -1153,8 +1153,8 @@
"NullableInteger": {
"base": null,
"refs": {
"Authorizer$authorizerResultTtlInSeconds": "<p>The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>",
"CreateAuthorizerRequest$authorizerResultTtlInSeconds": "<p>The TTL of cached authorizer results.</p>",
"Authorizer$authorizerResultTtlInSeconds": "<p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>",
"CreateAuthorizerRequest$authorizerResultTtlInSeconds": "<p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>",
"GetApiKeysRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetAuthorizersRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetBasePathMappingsRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
@@ -1304,7 +1304,7 @@
}
},
"ServiceUnavailableException": {
"base": null,
"base": "<p>The requested service is not available. For details see the accompanying error message. Retry after the specified time period.</p>",
"refs": {
}
},
@@ -1357,11 +1357,11 @@
"ApiStage$stage": "<p>API stage name of the associated API stage in a usage plan.</p>",
"Authorizer$id": "<p>The identifier for the authorizer resource.</p>",
"Authorizer$name": "<p>[Required] The name of the authorizer.</p>",
"Authorizer$authType": "<p>Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.</p>",
"Authorizer$authorizerUri": "<p>[Required] Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.</p>",
"Authorizer$authorizerCredentials": "<p>Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>",
"Authorizer$identitySource": "<p>[Required] The source of the identity in an incoming request. For a <code>TOKEN</code> authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For <code>COGNITO_USER_POOLS</code> authorizers, this property is used.</p>",
"Authorizer$identityValidationExpression": "<p>A validation expression for the incoming identity. For <code>TOKEN</code> authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.</p>",
"Authorizer$authType": "<p>Optional customer-defined field, used in Swagger imports and exports without functional impact.</p>",
"Authorizer$authorizerUri": "<p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>",
"Authorizer$authorizerCredentials": "<p>Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>",
"Authorizer$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li><li>For a <code>COGNITO_USER_POOLS</code> authorizer, this property is not used.</li></ul></p>",
"Authorizer$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
"Authorizers$position": null,
"BadRequestException$message": null,
"BasePathMapping$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>",
@@ -1379,11 +1379,11 @@
"CreateApiKeyRequest$customerId": "<p>An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.</p>",
"CreateAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"CreateAuthorizerRequest$name": "<p>[Required] The name of the authorizer.</p>",
"CreateAuthorizerRequest$authType": "<p>Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.</p>",
"CreateAuthorizerRequest$authorizerUri": "<p>[Required] Specifies the authorizer's Uniform Resource Identifier (URI).</p>",
"CreateAuthorizerRequest$authorizerCredentials": "<p>Specifies the credentials required for the authorizer, if any.</p>",
"CreateAuthorizerRequest$identitySource": "<p>[Required] The source of the identity in an incoming request.</p>",
"CreateAuthorizerRequest$identityValidationExpression": "<p>A validation expression for the incoming identity.</p>",
"CreateAuthorizerRequest$authType": "<p>Optional customer-defined field, used in Swagger imports and exports without functional impact.</p>",
"CreateAuthorizerRequest$authorizerUri": "<p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>",
"CreateAuthorizerRequest$authorizerCredentials": "<p>Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>",
"CreateAuthorizerRequest$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li><li>For a <code>COGNITO_USER_POOLS</code> authorizer, this property is not used.</li></ul></p>",
"CreateAuthorizerRequest$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
"CreateBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to create.</p>",
"CreateBasePathMappingRequest$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.</p>",
"CreateBasePathMappingRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
@@ -1405,7 +1405,7 @@
"CreateDomainNameRequest$certificateChain": "<p>[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.</p>",
"CreateDomainNameRequest$certificateArn": "<p>The reference to an AWS-managed certificate. AWS Certificate Manager is the only supported source.</p>",
"CreateModelRequest$restApiId": "<p>The <a>RestApi</a> identifier under which the <a>Model</a> will be created.</p>",
"CreateModelRequest$name": "<p>The name of the model.</p>",
"CreateModelRequest$name": "<p>The name of the model. Must be alphanumeric.</p>",
"CreateModelRequest$description": "<p>The description of the model.</p>",
"CreateModelRequest$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"http://json-schema.org/documentation.html\" target=\"_blank\">JSON-schema draft v4</a> model.</p>",
"CreateModelRequest$contentType": "<p>The content-type for the model.</p>",
@@ -1558,7 +1558,7 @@
"GetRestApisRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetSdkRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetSdkRequest$stageName": "<p>The name of the <a>Stage</a> that the SDK will use.</p>",
"GetSdkRequest$sdkType": "<p>The language for the generated SDK. Currently <code>javascript</code>, <code>android</code>, and <code>objectivec</code> (for iOS) are supported.</p>",
"GetSdkRequest$sdkType": "<p>The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> and <code>swift</code> (for iOS) are supported.</p>",
"GetSdkTypeRequest$id": "<p>The identifier of the queried <a>SdkType</a> instance.</p>",
"GetSdkTypesRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
@@ -1608,7 +1608,7 @@
"MethodSetting$loggingLevel": "<p>Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is <code>/{method_setting_key}/logging/loglevel</code>, and the available levels are <code>OFF</code>, <code>ERROR</code>, and <code>INFO</code>.</p>",
"MethodSnapshot$authorizationType": "<p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>",
"Model$id": "<p>The identifier for the model resource.</p>",
"Model$name": "<p>The name of the model.</p>",
"Model$name": "<p>The name of the model. Must be an alphanumeric string.</p>",
"Model$description": "<p>The description of the model.</p>",
"Model$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"http://json-schema.org/documentation.html\" target=\"_blank\">JSON-schema draft v4</a> model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.</p>",
"Model$contentType": "<p>The content-type for the model.</p>",
@@ -1796,7 +1796,7 @@
}
},
"TooManyRequestsException": {
"base": null,
"base": "<p>The request has reached its throttling limit. Retry after the specified time period.</p>",
"refs": {
}
},
@@ -1807,7 +1807,7 @@
}
},
"UnauthorizedException": {
"base": null,
"base": "<p>The request is denied because the caller has insufficient permissions.</p>",
"refs": {
}
},

4
vendor/github.com/aws/aws-sdk-go/models/apis/application-autoscaling/2016-02-06/api-2.json generated vendored
View File

@@ -261,6 +261,7 @@
"NextToken":{"shape":"XmlString"}
}
},
"DisableScaleIn":{"type":"boolean"},
"ErrorMessage":{"type":"string"},
"FailedResourceAccessException":{
"type":"structure",
@@ -582,7 +583,8 @@
"PredefinedMetricSpecification":{"shape":"PredefinedMetricSpecification"},
"CustomizedMetricSpecification":{"shape":"CustomizedMetricSpecification"},
"ScaleOutCooldown":{"shape":"Cooldown"},
"ScaleInCooldown":{"shape":"Cooldown"}
"ScaleInCooldown":{"shape":"Cooldown"},
"DisableScaleIn":{"shape":"DisableScaleIn"}
}
},
"TimestampType":{"type":"timestamp"},

8
vendor/github.com/aws/aws-sdk-go/models/apis/application-autoscaling/2016-02-06/docs-2.json generated vendored
View File

@@ -1,6 +1,6 @@
{
"version": "2.0",
"service": "<p>With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of <a href=\"https://aws.amazon.com/autoscaling/\">Auto Scaling</a>. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TargetTracking.html\">Auto Scaling for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>",
"service": "<p>With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of <a href=\"https://aws.amazon.com/autoscaling/\">Auto Scaling</a>. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>",
"operations": {
"DeleteScalingPolicy": "<p>Deletes the specified Application Auto Scaling scaling policy.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>",
"DeregisterScalableTarget": "<p>Deregisters a scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>.</p>",
@@ -99,6 +99,12 @@
"refs": {
}
},
"DisableScaleIn": {
"base": null,
"refs": {
"TargetTrackingScalingPolicyConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is <code>false</code>.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {

493
vendor/github.com/aws/aws-sdk-go/models/apis/appstream/2016-12-01/api-2.json generated vendored
View File

@@ -24,7 +24,21 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"},
{"shape":"IncompatibleImageException"}
{"shape":"IncompatibleImageException"},
{"shape":"OperationNotPermittedException"}
]
},
"CreateDirectoryConfig":{
"name":"CreateDirectoryConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDirectoryConfigRequest"},
"output":{"shape":"CreateDirectoryConfigResult"},
"errors":[
{"shape":"ResourceAlreadyExistsException"},
{"shape":"LimitExceededException"}
]
},
"CreateFleet":{
@@ -41,7 +55,41 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidRoleException"},
{"shape":"ConcurrentModificationException"}
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidParameterCombinationException"},
{"shape":"IncompatibleImageException"}
]
},
"CreateImageBuilder":{
"name":"CreateImageBuilder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateImageBuilderRequest"},
"output":{"shape":"CreateImageBuilderResult"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotAvailableException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRoleException"},
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidParameterCombinationException"},
{"shape":"IncompatibleImageException"}
]
},
"CreateImageBuilderStreamingURL":{
"name":"CreateImageBuilderStreamingURL",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateImageBuilderStreamingURLRequest"},
"output":{"shape":"CreateImageBuilderStreamingURLResult"},
"errors":[
{"shape":"OperationNotPermittedException"},
{"shape":"ResourceNotFoundException"}
]
},
"CreateStack":{
@@ -76,6 +124,19 @@
{"shape":"InvalidParameterCombinationException"}
]
},
"DeleteDirectoryConfig":{
"name":"DeleteDirectoryConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDirectoryConfigRequest"},
"output":{"shape":"DeleteDirectoryConfigResult"},
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
]
},
"DeleteFleet":{
"name":"DeleteFleet",
"http":{
@@ -90,6 +151,35 @@
{"shape":"ConcurrentModificationException"}
]
},
"DeleteImage":{
"name":"DeleteImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteImageRequest"},
"output":{"shape":"DeleteImageResult"},
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OperationNotPermittedException"},
{"shape":"ConcurrentModificationException"}
]
},
"DeleteImageBuilder":{
"name":"DeleteImageBuilder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteImageBuilderRequest"},
"output":{"shape":"DeleteImageBuilderResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"OperationNotPermittedException"},
{"shape":"ConcurrentModificationException"}
]
},
"DeleteStack":{
"name":"DeleteStack",
"http":{
@@ -104,6 +194,18 @@
{"shape":"ConcurrentModificationException"}
]
},
"DescribeDirectoryConfigs":{
"name":"DescribeDirectoryConfigs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDirectoryConfigsRequest"},
"output":{"shape":"DescribeDirectoryConfigsResult"},
"errors":[
{"shape":"ResourceNotFoundException"}
]
},
"DescribeFleets":{
"name":"DescribeFleets",
"http":{
@@ -116,6 +218,18 @@
{"shape":"ResourceNotFoundException"}
]
},
"DescribeImageBuilders":{
"name":"DescribeImageBuilders",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeImageBuildersRequest"},
"output":{"shape":"DescribeImageBuildersResult"},
"errors":[
{"shape":"ResourceNotFoundException"}
]
},
"DescribeImages":{
"name":"DescribeImages",
"http":{
@@ -208,6 +322,20 @@
{"shape":"ConcurrentModificationException"}
]
},
"StartImageBuilder":{
"name":"StartImageBuilder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartImageBuilderRequest"},
"output":{"shape":"StartImageBuilderResult"},
"errors":[
{"shape":"ResourceNotAvailableException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"}
]
},
"StopFleet":{
"name":"StopFleet",
"http":{
@@ -221,6 +349,34 @@
{"shape":"ConcurrentModificationException"}
]
},
"StopImageBuilder":{
"name":"StopImageBuilder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopImageBuilderRequest"},
"output":{"shape":"StopImageBuilderResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"OperationNotPermittedException"},
{"shape":"ConcurrentModificationException"}
]
},
"UpdateDirectoryConfig":{
"name":"UpdateDirectoryConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDirectoryConfigRequest"},
"output":{"shape":"UpdateDirectoryConfigResult"},
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"}
]
},
"UpdateFleet":{
"name":"UpdateFleet",
"http":{
@@ -237,7 +393,8 @@
{"shape":"ResourceNotAvailableException"},
{"shape":"InvalidParameterCombinationException"},
{"shape":"ConcurrentModificationException"},
{"shape":"IncompatibleImageException"}
{"shape":"IncompatibleImageException"},
{"shape":"OperationNotPermittedException"}
]
},
"UpdateStack":{
@@ -259,6 +416,17 @@
}
},
"shapes":{
"AccountName":{
"type":"string",
"min":1,
"sensitive":true
},
"AccountPassword":{
"type":"string",
"max":127,
"min":1,
"sensitive":true
},
"Application":{
"type":"structure",
"members":{
@@ -329,6 +497,25 @@
},
"exception":true
},
"CreateDirectoryConfigRequest":{
"type":"structure",
"required":[
"DirectoryName",
"OrganizationalUnitDistinguishedNames",
"ServiceAccountCredentials"
],
"members":{
"DirectoryName":{"shape":"DirectoryName"},
"OrganizationalUnitDistinguishedNames":{"shape":"OrganizationalUnitDistinguishedNamesList"},
"ServiceAccountCredentials":{"shape":"ServiceAccountCredentials"}
}
},
"CreateDirectoryConfigResult":{
"type":"structure",
"members":{
"DirectoryConfig":{"shape":"DirectoryConfig"}
}
},
"CreateFleetRequest":{
"type":"structure",
"required":[
@@ -341,13 +528,15 @@
"Name":{"shape":"Name"},
"ImageName":{"shape":"String"},
"InstanceType":{"shape":"String"},
"FleetType":{"shape":"FleetType"},
"ComputeCapacity":{"shape":"ComputeCapacity"},
"VpcConfig":{"shape":"VpcConfig"},
"MaxUserDurationInSeconds":{"shape":"Integer"},
"DisconnectTimeoutInSeconds":{"shape":"Integer"},
"Description":{"shape":"Description"},
"DisplayName":{"shape":"DisplayName"},
"EnableDefaultInternetAccess":{"shape":"BooleanObject"}
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
"DomainJoinInfo":{"shape":"DomainJoinInfo"}
}
},
"CreateFleetResult":{
@@ -356,6 +545,45 @@
"Fleet":{"shape":"Fleet"}
}
},
"CreateImageBuilderRequest":{
"type":"structure",
"required":[
"Name",
"ImageName",
"InstanceType"
],
"members":{
"Name":{"shape":"Name"},
"ImageName":{"shape":"String"},
"InstanceType":{"shape":"String"},
"Description":{"shape":"Description"},
"DisplayName":{"shape":"DisplayName"},
"VpcConfig":{"shape":"VpcConfig"},
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
"DomainJoinInfo":{"shape":"DomainJoinInfo"}
}
},
"CreateImageBuilderResult":{
"type":"structure",
"members":{
"ImageBuilder":{"shape":"ImageBuilder"}
}
},
"CreateImageBuilderStreamingURLRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"String"},
"Validity":{"shape":"Long"}
}
},
"CreateImageBuilderStreamingURLResult":{
"type":"structure",
"members":{
"StreamingURL":{"shape":"String"},
"Expires":{"shape":"Timestamp"}
}
},
"CreateStackRequest":{
"type":"structure",
"required":["Name"],
@@ -382,7 +610,7 @@
"members":{
"StackName":{"shape":"String"},
"FleetName":{"shape":"String"},
"UserId":{"shape":"UserId"},
"UserId":{"shape":"StreamingUrlUserId"},
"ApplicationId":{"shape":"String"},
"Validity":{"shape":"Long"},
"SessionContext":{"shape":"String"}
@@ -395,6 +623,18 @@
"Expires":{"shape":"Timestamp"}
}
},
"DeleteDirectoryConfigRequest":{
"type":"structure",
"required":["DirectoryName"],
"members":{
"DirectoryName":{"shape":"DirectoryName"}
}
},
"DeleteDirectoryConfigResult":{
"type":"structure",
"members":{
}
},
"DeleteFleetRequest":{
"type":"structure",
"required":["Name"],
@@ -407,6 +647,32 @@
"members":{
}
},
"DeleteImageBuilderRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"Name"}
}
},
"DeleteImageBuilderResult":{
"type":"structure",
"members":{
"ImageBuilder":{"shape":"ImageBuilder"}
}
},
"DeleteImageRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"Name"}
}
},
"DeleteImageResult":{
"type":"structure",
"members":{
"Image":{"shape":"Image"}
}
},
"DeleteStackRequest":{
"type":"structure",
"required":["Name"],
@@ -419,6 +685,21 @@
"members":{
}
},
"DescribeDirectoryConfigsRequest":{
"type":"structure",
"members":{
"DirectoryNames":{"shape":"DirectoryNameList"},
"MaxResults":{"shape":"Integer"},
"NextToken":{"shape":"String"}
}
},
"DescribeDirectoryConfigsResult":{
"type":"structure",
"members":{
"DirectoryConfigs":{"shape":"DirectoryConfigList"},
"NextToken":{"shape":"String"}
}
},
"DescribeFleetsRequest":{
"type":"structure",
"members":{
@@ -433,6 +714,21 @@
"NextToken":{"shape":"String"}
}
},
"DescribeImageBuildersRequest":{
"type":"structure",
"members":{
"Names":{"shape":"StringList"},
"MaxResults":{"shape":"Integer"},
"NextToken":{"shape":"String"}
}
},
"DescribeImageBuildersResult":{
"type":"structure",
"members":{
"ImageBuilders":{"shape":"ImageBuilderList"},
"NextToken":{"shape":"String"}
}
},
"DescribeImagesRequest":{
"type":"structure",
"members":{
@@ -485,6 +781,25 @@
"type":"string",
"max":256
},
"DirectoryConfig":{
"type":"structure",
"required":["DirectoryName"],
"members":{
"DirectoryName":{"shape":"DirectoryName"},
"OrganizationalUnitDistinguishedNames":{"shape":"OrganizationalUnitDistinguishedNamesList"},
"ServiceAccountCredentials":{"shape":"ServiceAccountCredentials"},
"CreatedTime":{"shape":"Timestamp"}
}
},
"DirectoryConfigList":{
"type":"list",
"member":{"shape":"DirectoryConfig"}
},
"DirectoryName":{"type":"string"},
"DirectoryNameList":{
"type":"list",
"member":{"shape":"DirectoryName"}
},
"DisassociateFleetRequest":{
"type":"structure",
"required":[
@@ -505,6 +820,13 @@
"type":"string",
"max":100
},
"DomainJoinInfo":{
"type":"structure",
"members":{
"DirectoryName":{"shape":"DirectoryName"},
"OrganizationalUnitDistinguishedName":{"shape":"OrganizationalUnitDistinguishedName"}
}
},
"ErrorMessage":{"type":"string"},
"ExpireSessionRequest":{
"type":"structure",
@@ -535,6 +857,7 @@
"Description":{"shape":"String"},
"ImageName":{"shape":"String"},
"InstanceType":{"shape":"String"},
"FleetType":{"shape":"FleetType"},
"ComputeCapacityStatus":{"shape":"ComputeCapacityStatus"},
"MaxUserDurationInSeconds":{"shape":"Integer"},
"DisconnectTimeoutInSeconds":{"shape":"Integer"},
@@ -542,14 +865,16 @@
"VpcConfig":{"shape":"VpcConfig"},
"CreatedTime":{"shape":"Timestamp"},
"FleetErrors":{"shape":"FleetErrors"},
"EnableDefaultInternetAccess":{"shape":"BooleanObject"}
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
"DomainJoinInfo":{"shape":"DomainJoinInfo"}
}
},
"FleetAttribute":{
"type":"string",
"enum":[
"VPC_CONFIGURATION",
"VPC_CONFIGURATION_SECURITY_GROUP_IDS"
"VPC_CONFIGURATION_SECURITY_GROUP_IDS",
"DOMAIN_JOIN_INFO"
]
},
"FleetAttributes":{
@@ -576,7 +901,22 @@
"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION",
"SUBNET_NOT_FOUND",
"IMAGE_NOT_FOUND",
"INVALID_SUBNET_CONFIGURATION"
"INVALID_SUBNET_CONFIGURATION",
"SECURITY_GROUPS_NOT_FOUND",
"IGW_NOT_ATTACHED",
"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION",
"DOMAIN_JOIN_ERROR_FILE_NOT_FOUND",
"DOMAIN_JOIN_ERROR_ACCESS_DENIED",
"DOMAIN_JOIN_ERROR_LOGON_FAILURE",
"DOMAIN_JOIN_ERROR_INVALID_PARAMETER",
"DOMAIN_JOIN_ERROR_MORE_DATA",
"DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN",
"DOMAIN_JOIN_ERROR_NOT_SUPPORTED",
"DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME",
"DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED",
"DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED",
"DOMAIN_JOIN_NERR_PASSWORD_EXPIRED",
"DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
]
},
"FleetErrors":{
@@ -596,6 +936,13 @@
"STOPPED"
]
},
"FleetType":{
"type":"string",
"enum":[
"ALWAYS_ON",
"ON_DEMAND"
]
},
"Image":{
"type":"structure",
"required":["Name"],
@@ -615,6 +962,57 @@
"PublicBaseImageReleasedDate":{"shape":"Timestamp"}
}
},
"ImageBuilder":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"String"},
"Arn":{"shape":"Arn"},
"ImageArn":{"shape":"Arn"},
"Description":{"shape":"String"},
"DisplayName":{"shape":"String"},
"VpcConfig":{"shape":"VpcConfig"},
"InstanceType":{"shape":"String"},
"Platform":{"shape":"PlatformType"},
"State":{"shape":"ImageBuilderState"},
"StateChangeReason":{"shape":"ImageBuilderStateChangeReason"},
"CreatedTime":{"shape":"Timestamp"},
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
"DomainJoinInfo":{"shape":"DomainJoinInfo"},
"ImageBuilderErrors":{"shape":"ResourceErrors"}
}
},
"ImageBuilderList":{
"type":"list",
"member":{"shape":"ImageBuilder"}
},
"ImageBuilderState":{
"type":"string",
"enum":[
"PENDING",
"RUNNING",
"STOPPING",
"STOPPED",
"REBOOTING",
"SNAPSHOTTING",
"DELETING",
"FAILED"
]
},
"ImageBuilderStateChangeReason":{
"type":"structure",
"members":{
"Code":{"shape":"ImageBuilderStateChangeReasonCode"},
"Message":{"shape":"String"}
}
},
"ImageBuilderStateChangeReasonCode":{
"type":"string",
"enum":[
"INTERNAL_ERROR",
"IMAGE_UNAVAILABLE"
]
},
"ImageList":{
"type":"list",
"member":{"shape":"Image"}
@@ -718,6 +1116,14 @@
},
"exception":true
},
"OrganizationalUnitDistinguishedName":{
"type":"string",
"max":2000
},
"OrganizationalUnitDistinguishedNamesList":{
"type":"list",
"member":{"shape":"OrganizationalUnitDistinguishedName"}
},
"PlatformType":{
"type":"string",
"enum":["WINDOWS"]
@@ -729,6 +1135,18 @@
},
"exception":true
},
"ResourceError":{
"type":"structure",
"members":{
"ErrorCode":{"shape":"FleetErrorCode"},
"ErrorMessage":{"shape":"String"},
"ErrorTimestamp":{"shape":"Timestamp"}
}
},
"ResourceErrors":{
"type":"list",
"member":{"shape":"ResourceError"}
},
"ResourceIdentifier":{
"type":"string",
"min":1
@@ -759,6 +1177,17 @@
"member":{"shape":"String"},
"max":5
},
"ServiceAccountCredentials":{
"type":"structure",
"required":[
"AccountName",
"AccountPassword"
],
"members":{
"AccountName":{"shape":"AccountName"},
"AccountPassword":{"shape":"AccountPassword"}
}
},
"Session":{
"type":"structure",
"required":[
@@ -836,6 +1265,19 @@
"members":{
}
},
"StartImageBuilderRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"String"}
}
},
"StartImageBuilderResult":{
"type":"structure",
"members":{
"ImageBuilder":{"shape":"ImageBuilder"}
}
},
"StopFleetRequest":{
"type":"structure",
"required":["Name"],
@@ -848,6 +1290,19 @@
"members":{
}
},
"StopImageBuilderRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"String"}
}
},
"StopImageBuilderResult":{
"type":"structure",
"members":{
"ImageBuilder":{"shape":"ImageBuilder"}
}
},
"StorageConnector":{
"type":"structure",
"required":["ConnectorType"],
@@ -864,6 +1319,12 @@
"type":"string",
"enum":["HOMEFOLDERS"]
},
"StreamingUrlUserId":{
"type":"string",
"max":32,
"min":2,
"pattern":"[\\w+=,.@-]*"
},
"String":{
"type":"string",
"min":1
@@ -877,6 +1338,21 @@
"member":{"shape":"String"}
},
"Timestamp":{"type":"timestamp"},
"UpdateDirectoryConfigRequest":{
"type":"structure",
"required":["DirectoryName"],
"members":{
"DirectoryName":{"shape":"DirectoryName"},
"OrganizationalUnitDistinguishedNames":{"shape":"OrganizationalUnitDistinguishedNamesList"},
"ServiceAccountCredentials":{"shape":"ServiceAccountCredentials"}
}
},
"UpdateDirectoryConfigResult":{
"type":"structure",
"members":{
"DirectoryConfig":{"shape":"DirectoryConfig"}
}
},
"UpdateFleetRequest":{
"type":"structure",
"required":["Name"],
@@ -895,6 +1371,7 @@
"Description":{"shape":"Description"},
"DisplayName":{"shape":"DisplayName"},
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
"DomainJoinInfo":{"shape":"DomainJoinInfo"},
"AttributesToDelete":{"shape":"FleetAttributes"}
}
},

601
vendor/github.com/aws/aws-sdk-go/models/apis/appstream/2016-12-01/docs-2.json generated vendored
View File

@@ -1,29 +1,52 @@
{
"version": "2.0",
"service": "<fullname>Amazon AppStream 2.0</fullname> <p>API documentation for Amazon AppStream 2.0.</p>",
"service": "<fullname>Amazon AppStream 2.0</fullname> <p>You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.</p>",
"operations": {
"AssociateFleet": "<p>Associate a fleet to a stack.</p>",
"CreateFleet": "<p>Creates a new fleet.</p>",
"CreateStack": "<p>Create a new stack.</p>",
"CreateStreamingURL": "<p>Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.</p>",
"DeleteFleet": "<p>Deletes a fleet.</p>",
"DeleteStack": "<p>Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.</p>",
"DescribeFleets": "<p>If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.</p>",
"DescribeImages": "<p>Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.</p>",
"DescribeSessions": "<p>Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the <code>nextToken</code> parameter in a subsequent call to this operation to retrieve the next set of items. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.</p>",
"DescribeStacks": "<p>If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the <code>nextToken</code> value in a subsequent call to this operation to retrieve the next set of items.</p>",
"DisassociateFleet": "<p>Disassociates a fleet from a stack.</p>",
"ExpireSession": "<p>This operation immediately stops a streaming session.</p>",
"ListAssociatedFleets": "<p>Lists all fleets associated with the stack.</p>",
"ListAssociatedStacks": "<p>Lists all stacks to which the specified fleet is associated.</p>",
"StartFleet": "<p>Starts a fleet.</p>",
"StopFleet": "<p>Stops a fleet.</p>",
"UpdateFleet": "<p>Updates an existing fleet. All the attributes except the fleet name can be updated in the <b>STOPPED</b> state. When a fleet is in the <b>RUNNING</b> state, only <code>DisplayName</code> and <code>ComputeCapacity</code> can be updated. A fleet cannot be updated in a status of <b>STARTING</b> or <b>STOPPING</b>.</p>",
"UpdateStack": "<p>Updates the specified fields in the stack with the specified name.</p>"
"AssociateFleet": "<p>Associates the specified fleet with the specified stack.</p>",
"CreateDirectoryConfig": "<p>Creates a directory configuration.</p>",
"CreateFleet": "<p>Creates a fleet.</p>",
"CreateImageBuilder": null,
"CreateImageBuilderStreamingURL": null,
"CreateStack": "<p>Creates a stack.</p>",
"CreateStreamingURL": "<p>Creates a URL to start a streaming session for the specified user.</p> <p>By default, the URL is valid only for one minute from the time that it is generated.</p>",
"DeleteDirectoryConfig": "<p>Deletes the specified directory configuration.</p>",
"DeleteFleet": "<p>Deletes the specified fleet.</p>",
"DeleteImage": null,
"DeleteImageBuilder": null,
"DeleteStack": "<p>Deletes the specified stack. After this operation completes, the environment can no longer be activated and any reservations made for the stack are released.</p>",
"DescribeDirectoryConfigs": "<p>Describes the specified directory configurations.</p>",
"DescribeFleets": "<p>Describes the specified fleets or all fleets in the account.</p>",
"DescribeImageBuilders": null,
"DescribeImages": "<p>Describes the specified images or all images in the account.</p>",
"DescribeSessions": "<p>Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>",
"DescribeStacks": "<p>Describes the specified stacks or all stacks in the account.</p>",
"DisassociateFleet": "<p>Disassociates the specified fleet from the specified stack.</p>",
"ExpireSession": "<p>Stops the specified streaming session.</p>",
"ListAssociatedFleets": "<p>Lists the fleets associated with the specified stack.</p>",
"ListAssociatedStacks": "<p>Lists the stacks associated with the specified fleet.</p>",
"StartFleet": "<p>Starts the specified fleet.</p>",
"StartImageBuilder": null,
"StopFleet": "<p>Stops the specified fleet.</p>",
"StopImageBuilder": null,
"UpdateDirectoryConfig": "<p>Updates the specified directory configuration.</p>",
"UpdateFleet": "<p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code> and <code>ComputeCapacity</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>",
"UpdateStack": "<p>Updates the specified stack.</p>"
},
"shapes": {
"AccountName": {
"base": null,
"refs": {
"ServiceAccountCredentials$AccountName": "<p>The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.</p>"
}
},
"AccountPassword": {
"base": null,
"refs": {
"ServiceAccountCredentials$AccountPassword": "<p>The password for the account.</p>"
}
},
"Application": {
"base": "<p>An entry for a single application in the application catalog.</p>",
"base": "<p>Describes an application in the application catalog.</p>",
"refs": {
"Applications$member": null
}
@@ -31,15 +54,17 @@
"Applications": {
"base": null,
"refs": {
"Image$Applications": "<p>The applications associated with an image.</p>"
"Image$Applications": "<p>The applications associated with the image.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"Fleet$Arn": "<p>The ARN for the fleet.</p>",
"Image$Arn": "<p>The ARN for the image.</p>",
"Image$BaseImageArn": "<p>The source image ARN from which this image was created.</p>",
"Image$Arn": "<p>The ARN of the image.</p>",
"Image$BaseImageArn": "<p>The ARN of the image from which this image was created.</p>",
"ImageBuilder$Arn": null,
"ImageBuilder$ImageArn": null,
"Stack$Arn": "<p>The ARN of the stack.</p>"
}
},
@@ -56,38 +81,40 @@
"AuthenticationType": {
"base": null,
"refs": {
"DescribeSessionsRequest$AuthenticationType": "<p>The authentication method of the user. It can be <code>API</code> for a user authenticated using a streaming URL, or <code>SAML</code> for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.</p>",
"Session$AuthenticationType": "<p>The authentication method of the user for whom the session was created. It can be <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user.</p>"
"DescribeSessionsRequest$AuthenticationType": "<p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>",
"Session$AuthenticationType": "<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>) or SAML federation (<code>SAML</code>).</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"Application$Enabled": "<p>An application can be disabled after image creation if there is a problem.</p>",
"Image$ImageBuilderSupported": "<p>Whether an image builder can be launched from this image.</p>",
"UpdateFleetRequest$DeleteVpcConfig": "<p>Delete the VPC association for the specified fleet.</p>",
"UpdateStackRequest$DeleteStorageConnectors": "<p>Remove all the storage connectors currently enabled for the stack.</p>"
"Application$Enabled": "<p>If there is a problem, the application can be disabled after image creation.</p>",
"Image$ImageBuilderSupported": "<p>Indicates whether an image builder can be launched from this image.</p>",
"UpdateFleetRequest$DeleteVpcConfig": "<p>Deletes the VPC association for the specified fleet.</p>",
"UpdateStackRequest$DeleteStorageConnectors": "<p>Deletes the storage connectors currently enabled for the stack.</p>"
}
},
"BooleanObject": {
"base": null,
"refs": {
"CreateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default Internet access for the fleet.</p>",
"Fleet$EnableDefaultInternetAccess": "<p>Whether default Internet access is enabled for the fleet. </p>",
"UpdateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default Internet access for the fleet.</p>"
"CreateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>",
"CreateImageBuilderRequest$EnableDefaultInternetAccess": null,
"Fleet$EnableDefaultInternetAccess": "<p>Indicates whether default internet access is enabled for the fleet.</p>",
"ImageBuilder$EnableDefaultInternetAccess": null,
"UpdateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>"
}
},
"ComputeCapacity": {
"base": "<p>The capacity configuration for the fleet.</p>",
"base": "<p>Describes the capacity for a fleet.</p>",
"refs": {
"CreateFleetRequest$ComputeCapacity": "<p>The parameters for the capacity allocated to the fleet.</p>",
"UpdateFleetRequest$ComputeCapacity": "<p>The parameters for the capacity allocated to the fleet. </p>"
"CreateFleetRequest$ComputeCapacity": "<p>The desired capacity for the fleet.</p>",
"UpdateFleetRequest$ComputeCapacity": "<p>The desired capacity for the fleet.</p>"
}
},
"ComputeCapacityStatus": {
"base": "<p>The capacity information for the fleet.</p>",
"base": "<p>Describes the capacity status for a fleet.</p>",
"refs": {
"Fleet$ComputeCapacityStatus": "<p>The capacity information for the fleet.</p>"
"Fleet$ComputeCapacityStatus": "<p>The capacity status for the fleet.</p>"
}
},
"ConcurrentModificationException": {
@@ -95,8 +122,18 @@
"refs": {
}
},
"CreateDirectoryConfigRequest": {
"base": null,
"refs": {
}
},
"CreateDirectoryConfigResult": {
"base": null,
"refs": {
}
},
"CreateFleetRequest": {
"base": "<p>Contains the parameters for the new fleet to create.</p>",
"base": null,
"refs": {
}
},
@@ -105,6 +142,26 @@
"refs": {
}
},
"CreateImageBuilderRequest": {
"base": null,
"refs": {
}
},
"CreateImageBuilderResult": {
"base": null,
"refs": {
}
},
"CreateImageBuilderStreamingURLRequest": {
"base": null,
"refs": {
}
},
"CreateImageBuilderStreamingURLResult": {
"base": null,
"refs": {
}
},
"CreateStackRequest": {
"base": null,
"refs": {
@@ -125,6 +182,16 @@
"refs": {
}
},
"DeleteDirectoryConfigRequest": {
"base": null,
"refs": {
}
},
"DeleteDirectoryConfigResult": {
"base": null,
"refs": {
}
},
"DeleteFleetRequest": {
"base": null,
"refs": {
@@ -135,6 +202,26 @@
"refs": {
}
},
"DeleteImageBuilderRequest": {
"base": null,
"refs": {
}
},
"DeleteImageBuilderResult": {
"base": null,
"refs": {
}
},
"DeleteImageRequest": {
"base": null,
"refs": {
}
},
"DeleteImageResult": {
"base": null,
"refs": {
}
},
"DeleteStackRequest": {
"base": null,
"refs": {
@@ -145,6 +232,16 @@
"refs": {
}
},
"DescribeDirectoryConfigsRequest": {
"base": null,
"refs": {
}
},
"DescribeDirectoryConfigsResult": {
"base": null,
"refs": {
}
},
"DescribeFleetsRequest": {
"base": null,
"refs": {
@@ -155,6 +252,16 @@
"refs": {
}
},
"DescribeImageBuildersRequest": {
"base": null,
"refs": {
}
},
"DescribeImageBuildersResult": {
"base": null,
"refs": {
}
},
"DescribeImagesRequest": {
"base": null,
"refs": {
@@ -188,10 +295,42 @@
"Description": {
"base": null,
"refs": {
"CreateFleetRequest$Description": "<p>The description of the fleet.</p>",
"CreateStackRequest$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>",
"UpdateFleetRequest$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>",
"UpdateStackRequest$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>"
"CreateFleetRequest$Description": "<p>The description displayed to end users.</p>",
"CreateImageBuilderRequest$Description": null,
"CreateStackRequest$Description": "<p>The description displayed to end users.</p>",
"UpdateFleetRequest$Description": "<p>The description displayed to end users.</p>",
"UpdateStackRequest$Description": "<p>The description displayed to end users.</p>"
}
},
"DirectoryConfig": {
"base": "<p>Configuration information for the directory used to join domains.</p>",
"refs": {
"CreateDirectoryConfigResult$DirectoryConfig": "<p>Information about the directory configuration.</p>",
"DirectoryConfigList$member": null,
"UpdateDirectoryConfigResult$DirectoryConfig": "<p>Information about the directory configuration.</p>"
}
},
"DirectoryConfigList": {
"base": null,
"refs": {
"DescribeDirectoryConfigsResult$DirectoryConfigs": "<p>Information about the directory configurations.</p>"
}
},
"DirectoryName": {
"base": null,
"refs": {
"CreateDirectoryConfigRequest$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
"DeleteDirectoryConfigRequest$DirectoryName": "<p>The name of the directory configuration.</p>",
"DirectoryConfig$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
"DirectoryNameList$member": null,
"DomainJoinInfo$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
"UpdateDirectoryConfigRequest$DirectoryName": "<p>The name of the directory configuration.</p>"
}
},
"DirectoryNameList": {
"base": null,
"refs": {
"DescribeDirectoryConfigsRequest$DirectoryNames": "<p>The directory names.</p>"
}
},
"DisassociateFleetRequest": {
@@ -207,10 +346,21 @@
"DisplayName": {
"base": null,
"refs": {
"CreateFleetRequest$DisplayName": "<p>The display name of the fleet.</p>",
"CreateStackRequest$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>",
"UpdateFleetRequest$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>",
"UpdateStackRequest$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>"
"CreateFleetRequest$DisplayName": "<p>The fleet name displayed to end users.</p>",
"CreateImageBuilderRequest$DisplayName": null,
"CreateStackRequest$DisplayName": "<p>The stack name displayed to end users.</p>",
"UpdateFleetRequest$DisplayName": "<p>The fleet name displayed to end users.</p>",
"UpdateStackRequest$DisplayName": "<p>The stack name displayed to end users.</p>"
}
},
"DomainJoinInfo": {
"base": "<p>Contains the information needed for streaming instances to join a domain.</p>",
"refs": {
"CreateFleetRequest$DomainJoinInfo": "<p>The information needed for streaming instances to join a domain.</p>",
"CreateImageBuilderRequest$DomainJoinInfo": null,
"Fleet$DomainJoinInfo": "<p>The information needed for streaming instances to join a domain.</p>",
"ImageBuilder$DomainJoinInfo": null,
"UpdateFleetRequest$DomainJoinInfo": "<p>The information needed for streaming instances to join a domain.</p>"
}
},
"ErrorMessage": {
@@ -241,25 +391,25 @@
"Fleet": {
"base": "<p>Contains the parameters for a fleet.</p>",
"refs": {
"CreateFleetResult$Fleet": "<p>The details for the created fleet.</p>",
"CreateFleetResult$Fleet": "<p>Information about the fleet.</p>",
"FleetList$member": null,
"UpdateFleetResult$Fleet": "<p>A list of fleet details.</p>"
"UpdateFleetResult$Fleet": "<p>Information about the fleet.</p>"
}
},
"FleetAttribute": {
"base": "<p>Fleet attribute.</p>",
"base": "<p>The fleet attribute.</p>",
"refs": {
"FleetAttributes$member": null
}
},
"FleetAttributes": {
"base": "<p>A list of fleet attributes.</p>",
"base": "<p>The fleet attributes.</p>",
"refs": {
"UpdateFleetRequest$AttributesToDelete": "<p>Fleet attributes to be deleted.</p>"
"UpdateFleetRequest$AttributesToDelete": "<p>The fleet attributes to delete.</p>"
}
},
"FleetError": {
"base": "<p>The details of the fleet error.</p>",
"base": "<p>Describes a fleet error.</p>",
"refs": {
"FleetErrors$member": null
}
@@ -267,19 +417,20 @@
"FleetErrorCode": {
"base": null,
"refs": {
"FleetError$ErrorCode": "<p>The error code for the fleet error.</p>"
"FleetError$ErrorCode": "<p>The error code.</p>",
"ResourceError$ErrorCode": null
}
},
"FleetErrors": {
"base": null,
"refs": {
"Fleet$FleetErrors": "<p>The list of fleet errors is appended to this list.</p>"
"Fleet$FleetErrors": "<p>The fleet errors.</p>"
}
},
"FleetList": {
"base": "<p>A list of fleets.</p>",
"base": "<p>The fleets.</p>",
"refs": {
"DescribeFleetsResult$Fleets": "<p>The list of fleet details.</p>"
"DescribeFleetsResult$Fleets": "<p>Information about the fleets.</p>"
}
},
"FleetState": {
@@ -288,26 +439,68 @@
"Fleet$State": "<p>The current state for the fleet.</p>"
}
},
"Image": {
"base": "<p>New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.</p>",
"FleetType": {
"base": null,
"refs": {
"CreateFleetRequest$FleetType": null,
"Fleet$FleetType": null
}
},
"Image": {
"base": "<p>Describes an image.</p>",
"refs": {
"DeleteImageResult$Image": null,
"ImageList$member": null
}
},
"ImageBuilder": {
"base": null,
"refs": {
"CreateImageBuilderResult$ImageBuilder": null,
"DeleteImageBuilderResult$ImageBuilder": null,
"ImageBuilderList$member": null,
"StartImageBuilderResult$ImageBuilder": null,
"StopImageBuilderResult$ImageBuilder": null
}
},
"ImageBuilderList": {
"base": null,
"refs": {
"DescribeImageBuildersResult$ImageBuilders": null
}
},
"ImageBuilderState": {
"base": null,
"refs": {
"ImageBuilder$State": null
}
},
"ImageBuilderStateChangeReason": {
"base": null,
"refs": {
"ImageBuilder$StateChangeReason": null
}
},
"ImageBuilderStateChangeReasonCode": {
"base": null,
"refs": {
"ImageBuilderStateChangeReason$Code": null
}
},
"ImageList": {
"base": null,
"refs": {
"DescribeImagesResult$Images": "<p>The list of images.</p>"
"DescribeImagesResult$Images": "<p>Information about the images.</p>"
}
},
"ImageState": {
"base": null,
"refs": {
"Image$State": "<p>The image starts in the <b>PENDING</b> state, and then moves to <b>AVAILABLE</b> if image creation succeeds and <b>FAILED</b> if image creation has failed.</p>"
"Image$State": "<p>The image starts in the <code>PENDING</code> state. If image creation succeeds, the state is <code>AVAILABLE</code>. If image creation fails, the state is <code>FAILED</code>.</p>"
}
},
"ImageStateChangeReason": {
"base": "<p>The reason why the last state change occurred.</p>",
"base": "<p>Describes the reason why the last state change occurred.</p>",
"refs": {
"Image$StateChangeReason": "<p>The reason why the last state change occurred.</p>"
}
@@ -315,7 +508,7 @@
"ImageStateChangeReasonCode": {
"base": null,
"refs": {
"ImageStateChangeReason$Code": "<p>The state change reason code of the image.</p>"
"ImageStateChangeReason$Code": "<p>The state change reason code.</p>"
}
},
"IncompatibleImageException": {
@@ -329,15 +522,17 @@
"ComputeCapacity$DesiredInstances": "<p>The desired number of streaming instances.</p>",
"ComputeCapacityStatus$Desired": "<p>The desired number of streaming instances.</p>",
"ComputeCapacityStatus$Running": "<p>The total number of simultaneous streaming instances that are running.</p>",
"ComputeCapacityStatus$InUse": "<p>The number of instances that are being used for streaming.</p>",
"ComputeCapacityStatus$InUse": "<p>The number of instances in use for streaming.</p>",
"ComputeCapacityStatus$Available": "<p>The number of currently available instances that can be used to stream sessions.</p>",
"CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.</p>",
"CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600. </p>",
"DescribeSessionsRequest$Limit": "<p>The size of each page of results. The default value is 20 and the maximum supported value is 50.</p>",
"Fleet$MaxUserDurationInSeconds": "<p>The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.</p>",
"Fleet$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.</p>",
"UpdateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.</p>",
"UpdateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.</p>"
"CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
"CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>",
"DescribeDirectoryConfigsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"DescribeImageBuildersRequest$MaxResults": null,
"DescribeSessionsRequest$Limit": "<p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>",
"Fleet$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
"Fleet$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>",
"UpdateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
"UpdateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>"
}
},
"InvalidParameterCombinationException": {
@@ -361,7 +556,7 @@
}
},
"ListAssociatedFleetsResult": {
"base": "<p>The response from a successful operation.</p>",
"base": null,
"refs": {
}
},
@@ -371,14 +566,15 @@
}
},
"ListAssociatedStacksResult": {
"base": "<p>The response from a successful operation.</p>",
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"CreateStreamingURLRequest$Validity": "<p>The duration up to which the URL returned by this action is valid. The input can be any numeric value in seconds between 1 and 604800 seconds.</p>"
"CreateImageBuilderStreamingURLRequest$Validity": null,
"CreateStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds.</p>"
}
},
"Metadata": {
@@ -390,7 +586,10 @@
"Name": {
"base": null,
"refs": {
"CreateFleetRequest$Name": "<p>A unique identifier for the fleet.</p>"
"CreateFleetRequest$Name": "<p>A unique name for the fleet.</p>",
"CreateImageBuilderRequest$Name": null,
"DeleteImageBuilderRequest$Name": null,
"DeleteImageRequest$Name": null
}
},
"OperationNotPermittedException": {
@@ -398,10 +597,26 @@
"refs": {
}
},
"OrganizationalUnitDistinguishedName": {
"base": null,
"refs": {
"DomainJoinInfo$OrganizationalUnitDistinguishedName": "<p>The distinguished name of the organizational unit for computer accounts.</p>",
"OrganizationalUnitDistinguishedNamesList$member": null
}
},
"OrganizationalUnitDistinguishedNamesList": {
"base": null,
"refs": {
"CreateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>",
"DirectoryConfig$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>",
"UpdateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>"
}
},
"PlatformType": {
"base": null,
"refs": {
"Image$Platform": "<p>The operating system platform of the image.</p>"
"Image$Platform": "<p>The operating system platform of the image.</p>",
"ImageBuilder$Platform": null
}
},
"ResourceAlreadyExistsException": {
@@ -409,10 +624,22 @@
"refs": {
}
},
"ResourceError": {
"base": null,
"refs": {
"ResourceErrors$member": null
}
},
"ResourceErrors": {
"base": null,
"refs": {
"ImageBuilder$ImageBuilderErrors": null
}
},
"ResourceIdentifier": {
"base": "<p>The ARN of the resource.</p>",
"refs": {
"StorageConnector$ResourceIdentifier": "<p>The ARN associated with the storage connector.</p>"
"StorageConnector$ResourceIdentifier": "<p>The ARN of the storage connector.</p>"
}
},
"ResourceInUseException": {
@@ -431,13 +658,21 @@
}
},
"SecurityGroupIdList": {
"base": "<p>A list of security groups.</p>",
"base": "<p>The security group IDs.</p>",
"refs": {
"VpcConfig$SecurityGroupIds": "<p>Security groups associated with the fleet.</p>"
"VpcConfig$SecurityGroupIds": "<p>The security groups for the fleet.</p>"
}
},
"ServiceAccountCredentials": {
"base": "<p>Describes the credentials for the service account used by the streaming instance to connect to the directory.</p>",
"refs": {
"CreateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the streaming instance to connect to the directory.</p>",
"DirectoryConfig$ServiceAccountCredentials": "<p>The credentials for the service account used by the streaming instance to connect to the directory.</p>",
"UpdateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the streaming instance to connect to the directory.</p>"
}
},
"Session": {
"base": "<p>Contains the parameters for a streaming session.</p>",
"base": "<p>Describes a streaming session.</p>",
"refs": {
"SessionList$member": null
}
@@ -445,7 +680,7 @@
"SessionList": {
"base": "<p>List of sessions.</p>",
"refs": {
"DescribeSessionsResult$Sessions": "<p>The list of streaming sessions.</p>"
"DescribeSessionsResult$Sessions": "<p>Information about the streaming sessions.</p>"
}
},
"SessionState": {
@@ -455,15 +690,15 @@
}
},
"Stack": {
"base": "<p>Details about a stack.</p>",
"base": "<p>Describes a stack.</p>",
"refs": {
"CreateStackResult$Stack": "<p>The details for the created stack.</p>",
"CreateStackResult$Stack": "<p>Information about the stack.</p>",
"StackList$member": null,
"UpdateStackResult$Stack": "<p>A list of stack details.</p>"
"UpdateStackResult$Stack": "<p>Information about the stack.</p>"
}
},
"StackError": {
"base": "<p>Contains the parameters for a stack error.</p>",
"base": "<p>Describes a stack error.</p>",
"refs": {
"StackErrors$member": null
}
@@ -471,19 +706,19 @@
"StackErrorCode": {
"base": null,
"refs": {
"StackError$ErrorCode": "<p>The error code of a stack error.</p>"
"StackError$ErrorCode": "<p>The error code.</p>"
}
},
"StackErrors": {
"base": "<p>A list of stack errors.</p>",
"base": "<p>The stack errors.</p>",
"refs": {
"Stack$StackErrors": "<p>The list of errors associated with the stack.</p>"
"Stack$StackErrors": "<p>The errors for the stack.</p>"
}
},
"StackList": {
"base": "<p>A list of stacks.</p>",
"base": "<p>The stacks.</p>",
"refs": {
"DescribeStacksResult$Stacks": "<p>The list of stack details.</p>"
"DescribeStacksResult$Stacks": "<p>Information about the stacks.</p>"
}
},
"StartFleetRequest": {
@@ -496,6 +731,16 @@
"refs": {
}
},
"StartImageBuilderRequest": {
"base": null,
"refs": {
}
},
"StartImageBuilderResult": {
"base": null,
"refs": {
}
},
"StopFleetRequest": {
"base": null,
"refs": {
@@ -506,117 +751,164 @@
"refs": {
}
},
"StopImageBuilderRequest": {
"base": null,
"refs": {
}
},
"StopImageBuilderResult": {
"base": null,
"refs": {
}
},
"StorageConnector": {
"base": "<p>Contains the parameters for a storage connector.</p>",
"base": "<p>Describes a storage connector.</p>",
"refs": {
"StorageConnectorList$member": null
}
},
"StorageConnectorList": {
"base": "<p>A list of storage connectors.</p>",
"base": "<p>The storage connectors.</p>",
"refs": {
"CreateStackRequest$StorageConnectors": "<p>The storage connectors to be enabled for the stack.</p>",
"Stack$StorageConnectors": "<p>The storage connectors to be enabled for the stack.</p>",
"UpdateStackRequest$StorageConnectors": "<p>The storage connectors to be enabled for the stack.</p>"
"CreateStackRequest$StorageConnectors": "<p>The storage connectors to enable.</p>",
"Stack$StorageConnectors": "<p>The storage connectors to enable.</p>",
"UpdateStackRequest$StorageConnectors": "<p>The storage connectors to enable.</p>"
}
},
"StorageConnectorType": {
"base": "<p>The type of storage connector. The possible values include: HOMEFOLDERS.</p>",
"base": "<p>The type of storage connector.</p>",
"refs": {
"StorageConnector$ConnectorType": "<p>The type of storage connector. The possible values include: HOMEFOLDERS.</p>"
"StorageConnector$ConnectorType": "<p>The type of storage connector.</p>"
}
},
"StreamingUrlUserId": {
"base": null,
"refs": {
"CreateStreamingURLRequest$UserId": "<p>The ID of the user.</p>"
}
},
"String": {
"base": null,
"refs": {
"Application$Name": "<p>The unique identifier for the application.</p>",
"Application$DisplayName": "<p>The name of the application shown to the end users.</p>",
"Application$IconURL": "<p>The URL for the application icon. This URL may be time-limited.</p>",
"Application$Name": "<p>The name of the application.</p>",
"Application$DisplayName": "<p>The application name displayed to end users.</p>",
"Application$IconURL": "<p>The URL for the application icon. This URL might be time-limited.</p>",
"Application$LaunchPath": "<p>The path to the application executable in the instance.</p>",
"Application$LaunchParameters": "<p>A list of arguments that are passed to the application at launch.</p>",
"AssociateFleetRequest$FleetName": "<p>The name of the fleet to associate.</p>",
"AssociateFleetRequest$StackName": "<p>The name of the stack to which the fleet is associated.</p>",
"CreateFleetRequest$ImageName": "<p>Unique name of the image used by the fleet.</p>",
"CreateFleetRequest$InstanceType": "<p>The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.</p>",
"CreateStackRequest$Name": "<p>The unique identifier for this stack.</p>",
"CreateStreamingURLRequest$StackName": "<p>The stack for which the URL is generated.</p>",
"CreateStreamingURLRequest$FleetName": "<p>The fleet for which the URL is generated.</p>",
"Application$LaunchParameters": "<p>The arguments that are passed to the application at launch.</p>",
"AssociateFleetRequest$FleetName": "<p>The name of the fleet.</p>",
"AssociateFleetRequest$StackName": "<p>The name of the stack.</p>",
"CreateFleetRequest$ImageName": "<p>The name of the image used by the fleet.</p>",
"CreateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>",
"CreateImageBuilderRequest$ImageName": null,
"CreateImageBuilderRequest$InstanceType": null,
"CreateImageBuilderStreamingURLRequest$Name": null,
"CreateImageBuilderStreamingURLResult$StreamingURL": null,
"CreateStackRequest$Name": "<p>The name of the stack.</p>",
"CreateStreamingURLRequest$StackName": "<p>The name of the stack.</p>",
"CreateStreamingURLRequest$FleetName": "<p>The name of the fleet.</p>",
"CreateStreamingURLRequest$ApplicationId": "<p>The ID of the application that must be launched after the session starts.</p>",
"CreateStreamingURLRequest$SessionContext": "<p>The sessionContext of the streaming URL.</p>",
"CreateStreamingURLRequest$SessionContext": "<p>The session context of the streaming URL.</p>",
"CreateStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>",
"DeleteFleetRequest$Name": "<p>The name of the fleet to be deleted.</p>",
"DeleteStackRequest$Name": "<p>The name of the stack to delete.</p>",
"DeleteFleetRequest$Name": "<p>The name of the fleet.</p>",
"DeleteStackRequest$Name": "<p>The name of the stack.</p>",
"DescribeDirectoryConfigsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"DescribeDirectoryConfigsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"DescribeFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"DescribeFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"DescribeSessionsRequest$StackName": "<p>The name of the stack for which to list sessions.</p>",
"DescribeSessionsRequest$FleetName": "<p>The name of the fleet for which to list sessions.</p>",
"DescribeImageBuildersRequest$NextToken": null,
"DescribeImageBuildersResult$NextToken": null,
"DescribeSessionsRequest$StackName": "<p>The name of the stack.</p>",
"DescribeSessionsRequest$FleetName": "<p>The name of the fleet.</p>",
"DescribeSessionsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"DescribeSessionsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"DescribeStacksRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"DescribeStacksResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"DisassociateFleetRequest$FleetName": "<p>The name of the fleet to disassociate.</p>",
"DisassociateFleetRequest$StackName": "<p>The name of the stack with which the fleet is associated.</p>",
"ExpireSessionRequest$SessionId": "<p>The unique identifier of the streaming session to be stopped.</p>",
"DisassociateFleetRequest$FleetName": "<p>The name of the fleet.</p>",
"DisassociateFleetRequest$StackName": "<p>The name of the stack.</p>",
"ExpireSessionRequest$SessionId": "<p>The ID of the streaming session.</p>",
"Fleet$Name": "<p>The name of the fleet.</p>",
"Fleet$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>",
"Fleet$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>",
"Fleet$DisplayName": "<p>The fleet name displayed to end users.</p>",
"Fleet$Description": "<p>The description displayed to end users.</p>",
"Fleet$ImageName": "<p>The image used by the fleet.</p>",
"Fleet$InstanceType": "<p>The instance type of compute resources for the fleet. The fleet instances are launched from this instance type. </p>",
"FleetError$ErrorMessage": "<p>The error message generated when the fleet has errors.</p>",
"Image$Name": "<p>The unique identifier for the image.</p>",
"Image$DisplayName": "<p>The display name for the image.</p>",
"Image$Description": "<p>A meaningful description for the image.</p>",
"ImageStateChangeReason$Message": "<p>The state change reason message to the end user.</p>",
"ListAssociatedFleetsRequest$StackName": "<p>The name of the stack whose associated fleets are listed.</p>",
"Fleet$InstanceType": "<p>The instance type to use when launching fleet instances.</p>",
"FleetError$ErrorMessage": "<p>The error message.</p>",
"Image$Name": "<p>The name of the image.</p>",
"Image$DisplayName": "<p>The image name displayed to end users.</p>",
"Image$Description": "<p>The description displayed to end users.</p>",
"ImageBuilder$Name": null,
"ImageBuilder$Description": null,
"ImageBuilder$DisplayName": null,
"ImageBuilder$InstanceType": null,
"ImageBuilderStateChangeReason$Message": null,
"ImageStateChangeReason$Message": "<p>The state change reason message.</p>",
"ListAssociatedFleetsRequest$StackName": "<p>The name of the stack.</p>",
"ListAssociatedFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"ListAssociatedFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"ListAssociatedStacksRequest$FleetName": "<p>The name of the fleet whose associated stacks are listed.</p>",
"ListAssociatedStacksRequest$FleetName": "<p>The name of the fleet.</p>",
"ListAssociatedStacksRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"ListAssociatedStacksResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"Metadata$key": null,
"Metadata$value": null,
"ResourceError$ErrorMessage": null,
"SecurityGroupIdList$member": null,
"Session$Id": "<p>The unique ID for a streaming session.</p>",
"Session$StackName": "<p>The name of the stack for which the streaming session was created.</p>",
"Session$FleetName": "<p>The name of the fleet for which the streaming session was created.</p>",
"Stack$Name": "<p>The unique identifier of the stack.</p>",
"Stack$Description": "<p>A meaningful description for the stack.</p>",
"Stack$DisplayName": "<p>A display name for the stack.</p>",
"StackError$ErrorMessage": "<p>The error message of a stack error.</p>",
"StartFleetRequest$Name": "<p>The name of the fleet to start.</p>",
"StopFleetRequest$Name": "<p>The name of the fleet to stop.</p>",
"Session$Id": "<p>The ID of the streaming session.</p>",
"Session$StackName": "<p>The name of the stack for the streaming session.</p>",
"Session$FleetName": "<p>The name of the fleet for the streaming session.</p>",
"Stack$Name": "<p>The name of the stack.</p>",
"Stack$Description": "<p>The description displayed to end users.</p>",
"Stack$DisplayName": "<p>The stack name displayed to end users.</p>",
"StackError$ErrorMessage": "<p>The error message.</p>",
"StartFleetRequest$Name": "<p>The name of the fleet.</p>",
"StartImageBuilderRequest$Name": null,
"StopFleetRequest$Name": "<p>The name of the fleet.</p>",
"StopImageBuilderRequest$Name": null,
"StringList$member": null,
"SubnetIdList$member": null,
"UpdateFleetRequest$ImageName": "<p>The image name from which a fleet is created.</p>",
"UpdateFleetRequest$Name": "<p>The name of the fleet.</p>",
"UpdateFleetRequest$InstanceType": "<p>The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.</p>",
"UpdateStackRequest$Name": "<p>The name of the stack to update.</p>"
"UpdateFleetRequest$ImageName": "<p>The name of the image used by the fleet.</p>",
"UpdateFleetRequest$Name": "<p>A unique name for the fleet.</p>",
"UpdateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>",
"UpdateStackRequest$Name": "<p>The name of the stack.</p>"
}
},
"StringList": {
"base": null,
"refs": {
"DescribeFleetsRequest$Names": "<p>The fleet names to describe. Use null to describe all the fleets for the AWS account.</p>",
"DescribeImagesRequest$Names": "<p>A specific list of images to describe.</p>",
"DescribeStacksRequest$Names": "<p>The stack names to describe. Use null to describe all the stacks for the AWS account.</p>",
"ListAssociatedFleetsResult$Names": "<p>The names of associated fleets.</p>",
"ListAssociatedStacksResult$Names": "<p>The names of associated stacks.</p>"
"DescribeFleetsRequest$Names": "<p>The names of the fleets to describe.</p>",
"DescribeImageBuildersRequest$Names": null,
"DescribeImagesRequest$Names": "<p>The names of the images to describe.</p>",
"DescribeStacksRequest$Names": "<p>The names of the stacks to describe.</p>",
"ListAssociatedFleetsResult$Names": "<p>The names of the fleets.</p>",
"ListAssociatedStacksResult$Names": "<p>The names of the stacks.</p>"
}
},
"SubnetIdList": {
"base": "<p>A list of subnet IDs.</p>",
"base": "<p>The subnet IDs.</p>",
"refs": {
"VpcConfig$SubnetIds": "<p>The list of subnets to which a network interface is established from the fleet instance.</p>"
"VpcConfig$SubnetIds": "<p>The subnets to which a network interface is established from the fleet instance.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"CreateStreamingURLResult$Expires": "<p>Elapsed seconds after the Unix epoch, at which time this URL expires.</p>",
"Fleet$CreatedTime": "<p>The time at which the fleet was created.</p>",
"Image$CreatedTime": "<p>The timestamp when the image was created.</p>",
"Image$PublicBaseImageReleasedDate": "<p>The AWS release date of the public base image. For private images, this date is the release date of the base image from which the image was created.</p>",
"Stack$CreatedTime": "<p>The timestamp when the stack was created.</p>"
"CreateImageBuilderStreamingURLResult$Expires": null,
"CreateStreamingURLResult$Expires": "<p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>",
"DirectoryConfig$CreatedTime": "<p>The time the directory configuration was created.</p>",
"Fleet$CreatedTime": "<p>The time the fleet was created.</p>",
"Image$CreatedTime": "<p>The time the image was created.</p>",
"Image$PublicBaseImageReleasedDate": "<p>The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.</p>",
"ImageBuilder$CreatedTime": null,
"ResourceError$ErrorTimestamp": null,
"Stack$CreatedTime": "<p>The time the stack was created.</p>"
}
},
"UpdateDirectoryConfigRequest": {
"base": null,
"refs": {
}
},
"UpdateDirectoryConfigResult": {
"base": null,
"refs": {
}
},
"UpdateFleetRequest": {
@@ -642,22 +934,23 @@
"UserId": {
"base": null,
"refs": {
"CreateStreamingURLRequest$UserId": "<p>A unique user ID for whom the URL is generated.</p>",
"DescribeSessionsRequest$UserId": "<p>The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.</p>",
"DescribeSessionsRequest$UserId": "<p>The user ID.</p>",
"Session$UserId": "<p>The identifier of the user for whom the session was created.</p>"
}
},
"VisibilityType": {
"base": null,
"refs": {
"Image$Visibility": "<p>The visibility of an image to the user; images can be public or private.</p>"
"Image$Visibility": "<p>Indicates whether the image is public or private.</p>"
}
},
"VpcConfig": {
"base": "<p>VPC configuration information.</p>",
"base": "<p>Describes VPC configuration information.</p>",
"refs": {
"CreateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>",
"CreateImageBuilderRequest$VpcConfig": null,
"Fleet$VpcConfig": "<p>The VPC configuration for the fleet.</p>",
"ImageBuilder$VpcConfig": null,
"UpdateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>"
}
}

12
vendor/github.com/aws/aws-sdk-go/models/apis/appstream/2016-12-01/waiters-2.json generated vendored
View File

@@ -9,19 +9,19 @@
{
"state": "success",
"matcher": "pathAll",
"argument": "fleets[].state",
"argument": "Fleets[].State",
"expected": "ACTIVE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "fleets[].state",
"argument": "Fleets[].State",
"expected": "PENDING_DEACTIVATE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "fleets[].state",
"argument": "Fleets[].State",
"expected": "INACTIVE"
}
]
@@ -34,19 +34,19 @@
{
"state": "success",
"matcher": "pathAll",
"argument": "fleets[].state",
"argument": "Fleets[].State",
"expected": "INACTIVE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "fleets[].state",
"argument": "Fleets[].State",
"expected": "PENDING_ACTIVATE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "fleets[].state",
"argument": "Fleets[].State",
"expected": "ACTIVE"
}
]

18
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling/2011-01-01/api-2.json generated vendored
View File

@@ -1045,6 +1045,7 @@
"VPCZoneIdentifier":{"shape":"XmlStringMaxLen2047"},
"TerminationPolicies":{"shape":"TerminationPolicies"},
"NewInstancesProtectedFromScaleIn":{"shape":"InstanceProtected"},
"LifecycleHookSpecificationList":{"shape":"LifecycleHookSpecifications"},
"Tags":{"shape":"Tags"}
}
},
@@ -1589,6 +1590,23 @@
"member":{"shape":"AsciiStringMaxLen255"},
"max":50
},
"LifecycleHookSpecification":{
"type":"structure",
"required":["LifecycleHookName"],
"members":{
"LifecycleHookName":{"shape":"AsciiStringMaxLen255"},
"LifecycleTransition":{"shape":"LifecycleTransition"},
"NotificationMetadata":{"shape":"XmlStringMaxLen1023"},
"HeartbeatTimeout":{"shape":"HeartbeatTimeout"},
"DefaultResult":{"shape":"LifecycleActionResult"},
"NotificationTargetARN":{"shape":"NotificationTargetResourceName"},
"RoleARN":{"shape":"ResourceName"}
}
},
"LifecycleHookSpecifications":{
"type":"list",
"member":{"shape":"LifecycleHookSpecification"}
},
"LifecycleHooks":{
"type":"list",
"member":{"shape":"LifecycleHook"}

205
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling/2011-01-01/docs-2.json generated vendored
View File

@@ -34,14 +34,14 @@
"DescribeScheduledActions": "<p>Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use <a>DescribeScalingActivities</a>.</p>",
"DescribeTags": "<p>Describes the specified tags.</p> <p>You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.</p> <p>You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.</p>",
"DescribeTerminationPolicyTypes": "<p>Describes the termination policies supported by Auto Scaling.</p>",
"DetachInstances": "<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
"DetachInstances": "<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independent of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
"DetachLoadBalancerTargetGroups": "<p>Detaches one or more target groups from the specified Auto Scaling group.</p>",
"DetachLoadBalancers": "<p>Detaches one or more Classic Load Balancers from the specified Auto Scaling group.</p> <p>Note that this operation detaches only Classic Load Balancers. If you have Application Load Balancers, use <a>DetachLoadBalancerTargetGroups</a> instead.</p> <p>When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running.</p>",
"DisableMetricsCollection": "<p>Disables group metrics for the specified Auto Scaling group.</p>",
"EnableMetricsCollection": "<p>Enables group metrics for the specified Auto Scaling group. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-monitoring.html\">Monitoring Your Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>",
"EnterStandby": "<p>Moves the specified instances into <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>",
"EnterStandby": "<p>Moves the specified instances into the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
"ExecutePolicy": "<p>Executes the specified policy.</p>",
"ExitStandby": "<p>Moves the specified instances out of <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>",
"ExitStandby": "<p>Moves the specified instances out of the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
"PutLifecycleHook": "<p>Creates or updates a lifecycle hook for the specified Auto Scaling Group.</p> <p>A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p> <b>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</b> </p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p>If you finish before the timeout period ends, complete the lifecycle action.</p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"PutNotificationConfiguration": "<p>Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.</p> <p>This configuration overwrites any existing configuration.</p> <p>For more information see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/ASGettingNotifications.html\">Getting SNS Notifications When Your Auto Scaling Group Scales</a> in the <i>Auto Scaling User Guide</i>.</p>",
"PutScalingPolicy": "<p>Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.</p> <p>If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>",
@@ -53,7 +53,7 @@
"SetInstanceProtection": "<p>Updates the instance protection settings of the specified instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-instance-termination.html#instance-protection\">Instance Protection</a> in the <i>Auto Scaling User Guide</i>.</p>",
"SuspendProcesses": "<p>Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.</p> <p>Note that if you suspend either the <code>Launch</code> or <code>Terminate</code> process types, it can prevent other process types from functioning properly.</p> <p>To resume processes that have been suspended, use <a>ResumeProcesses</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-suspend-resume-processes.html\">Suspending and Resuming Auto Scaling Processes</a> in the <i>Auto Scaling User Guide</i>.</p>",
"TerminateInstanceInAutoScalingGroup": "<p>Terminates the specified instance and optionally adjusts the desired group size.</p> <p>This call simply makes a termination request. The instance is not terminated immediately.</p>",
"UpdateAutoScalingGroup": "<p>Updates the configuration for the specified Auto Scaling group.</p> <p>To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>.</p> <p>The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.</p> <p>Note the following:</p> <ul> <li> <p>If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>.</p> </li> <li> <p>If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>.</p> </li> <li> <p>All other optional parameters are left unchanged if not specified.</p> </li> </ul>"
"UpdateAutoScalingGroup": "<p>Updates the configuration for the specified Auto Scaling group.</p> <p>The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.</p> <p>To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>false</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>.</p> <p>Note the following:</p> <ul> <li> <p>If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>.</p> </li> <li> <p>If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>.</p> </li> <li> <p>All other optional parameters are left unchanged if not specified.</p> </li> </ul>"
},
"shapes": {
"Activities": {
@@ -66,7 +66,7 @@
}
},
"ActivitiesType": {
"base": "<p>Contains the output of DescribeScalingActivities.</p>",
"base": null,
"refs": {
}
},
@@ -84,7 +84,7 @@
}
},
"ActivityType": {
"base": "<p>Contains the output of TerminateInstancesInAutoScalingGroup.</p>",
"base": null,
"refs": {
}
},
@@ -109,7 +109,7 @@
"Alarms": {
"base": null,
"refs": {
"PolicyARNType$Alarms": "<p>The CloudWatch alarms created for the target tracking policy. This parameter will be empty if the policy type is anything other than <code>TargetTrackingScaling</code>.</p>",
"PolicyARNType$Alarms": "<p>The CloudWatch alarms created for the target tracking policy.</p>",
"ScalingPolicy$Alarms": "<p>The CloudWatch alarms related to the policy.</p>"
}
},
@@ -125,6 +125,7 @@
"DeleteLifecycleHookType$LifecycleHookName": "<p>The name of the lifecycle hook.</p>",
"LifecycleHook$LifecycleHookName": "<p>The name of the lifecycle hook.</p>",
"LifecycleHookNames$member": null,
"LifecycleHookSpecification$LifecycleHookName": "<p>The name of the lifecycle hook.</p>",
"PutLifecycleHookType$LifecycleHookName": "<p>The name of the lifecycle hook.</p>",
"RecordLifecycleActionHeartbeatType$LifecycleHookName": "<p>The name of the lifecycle hook.</p>"
}
@@ -137,7 +138,7 @@
}
},
"AttachInstancesQuery": {
"base": "<p>Contains the parameters for AttachInstances.</p>",
"base": null,
"refs": {
}
},
@@ -147,17 +148,17 @@
}
},
"AttachLoadBalancerTargetGroupsType": {
"base": "<p>Contains the parameters for AttachLoadBalancerTargetGroups.</p>",
"base": null,
"refs": {
}
},
"AttachLoadBalancersResultType": {
"base": "<p>Contains the output of AttachLoadBalancers.</p>",
"base": null,
"refs": {
}
},
"AttachLoadBalancersType": {
"base": "<p>Contains the parameters for AttachLoadBalancers.</p>",
"base": null,
"refs": {
}
},
@@ -171,7 +172,7 @@
"base": null,
"refs": {
"AutoScalingGroup$DesiredCapacity": "<p>The desired size of the group.</p>",
"CreateAutoScalingGroupType$DesiredCapacity": "<p>The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.</p>",
"CreateAutoScalingGroupType$DesiredCapacity": "<p>The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.</p>",
"PutScheduledUpdateGroupActionType$DesiredCapacity": "<p>The number of EC2 instances that should be running in the group.</p>",
"ScheduledUpdateGroupAction$DesiredCapacity": "<p>The number of instances you prefer to maintain in the group.</p>",
"SetDesiredCapacityType$DesiredCapacity": "<p>The number of EC2 instances that should be running in the Auto Scaling group.</p>",
@@ -206,7 +207,7 @@
}
},
"AutoScalingGroupNamesType": {
"base": "<p>Contains the parameters for DescribeAutoScalingGroups.</p>",
"base": null,
"refs": {
}
},
@@ -217,7 +218,7 @@
}
},
"AutoScalingGroupsType": {
"base": "<p>Contains the output for DescribeAutoScalingGroups.</p>",
"base": null,
"refs": {
}
},
@@ -234,7 +235,7 @@
}
},
"AutoScalingInstancesType": {
"base": "<p>Contains the output of DescribeAutoScalingInstances.</p>",
"base": null,
"refs": {
}
},
@@ -305,12 +306,12 @@
}
},
"CompleteLifecycleActionAnswer": {
"base": "<p>Contains the output of CompleteLifecycleAction.</p>",
"base": null,
"refs": {
}
},
"CompleteLifecycleActionType": {
"base": "<p>Contains the parameters for CompleteLifecycleAction.</p>",
"base": null,
"refs": {
}
},
@@ -320,22 +321,22 @@
"AutoScalingGroup$DefaultCooldown": "<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.</p>",
"CreateAutoScalingGroupType$DefaultCooldown": "<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>",
"PutScalingPolicyType$Cooldown": "<p>The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.</p> <p>This parameter is supported if the policy type is <code>SimpleScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>",
"ScalingPolicy$Cooldown": "<p>The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.</p>",
"ScalingPolicy$Cooldown": "<p>The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.</p>",
"UpdateAutoScalingGroupType$DefaultCooldown": "<p>The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>"
}
},
"CreateAutoScalingGroupType": {
"base": "<p>Contains the parameters for CreateAutoScalingGroup.</p>",
"base": null,
"refs": {
}
},
"CreateLaunchConfigurationType": {
"base": "<p>Contains the parameters for CreateLaunchConfiguration.</p>",
"base": null,
"refs": {
}
},
"CreateOrUpdateTagsType": {
"base": "<p>Contains the parameters for CreateOrUpdateTags.</p>",
"base": null,
"refs": {
}
},
@@ -346,142 +347,142 @@
}
},
"DeleteAutoScalingGroupType": {
"base": "<p>Contains the parameters for DeleteAutoScalingGroup.</p>",
"base": null,
"refs": {
}
},
"DeleteLifecycleHookAnswer": {
"base": "<p>Contains the output of DeleteLifecycleHook.</p>",
"base": null,
"refs": {
}
},
"DeleteLifecycleHookType": {
"base": "<p>Contains the parameters for DeleteLifecycleHook.</p>",
"base": null,
"refs": {
}
},
"DeleteNotificationConfigurationType": {
"base": "<p>Contains the parameters for DeleteNotificationConfiguration.</p>",
"base": null,
"refs": {
}
},
"DeletePolicyType": {
"base": "<p>Contains the parameters for DeletePolicy.</p>",
"base": null,
"refs": {
}
},
"DeleteScheduledActionType": {
"base": "<p>Contains the parameters for DeleteScheduledAction.</p>",
"base": null,
"refs": {
}
},
"DeleteTagsType": {
"base": "<p>Contains the parameters for DeleteTags.</p>",
"base": null,
"refs": {
}
},
"DescribeAccountLimitsAnswer": {
"base": "<p>Contains the parameters for DescribeAccountLimits.</p>",
"base": null,
"refs": {
}
},
"DescribeAdjustmentTypesAnswer": {
"base": "<p>Contains the parameters for DescribeAdjustmentTypes.</p>",
"base": null,
"refs": {
}
},
"DescribeAutoScalingInstancesType": {
"base": "<p>Contains the parameters for DescribeAutoScalingInstances.</p>",
"base": null,
"refs": {
}
},
"DescribeAutoScalingNotificationTypesAnswer": {
"base": "<p>Contains the output of DescribeAutoScalingNotificationTypes.</p>",
"base": null,
"refs": {
}
},
"DescribeLifecycleHookTypesAnswer": {
"base": "<p>Contains the output of DescribeLifecycleHookTypes.</p>",
"base": null,
"refs": {
}
},
"DescribeLifecycleHooksAnswer": {
"base": "<p>Contains the output of DescribeLifecycleHooks.</p>",
"base": null,
"refs": {
}
},
"DescribeLifecycleHooksType": {
"base": "<p>Contains the parameters for DescribeLifecycleHooks.</p>",
"base": null,
"refs": {
}
},
"DescribeLoadBalancerTargetGroupsRequest": {
"base": "<p>Contains the parameters for DescribeLoadBalancerTargetGroups.</p>",
"base": null,
"refs": {
}
},
"DescribeLoadBalancerTargetGroupsResponse": {
"base": "<p>Contains the output of DescribeLoadBalancerTargetGroups.</p>",
"base": null,
"refs": {
}
},
"DescribeLoadBalancersRequest": {
"base": "<p>Contains the parameters for DescribeLoadBalancers.</p>",
"base": null,
"refs": {
}
},
"DescribeLoadBalancersResponse": {
"base": "<p>Contains the output of DescribeLoadBalancers.</p>",
"base": null,
"refs": {
}
},
"DescribeMetricCollectionTypesAnswer": {
"base": "<p>Contains the output of DescribeMetricsCollectionTypes.</p>",
"base": null,
"refs": {
}
},
"DescribeNotificationConfigurationsAnswer": {
"base": "<p>Contains the output from DescribeNotificationConfigurations.</p>",
"base": null,
"refs": {
}
},
"DescribeNotificationConfigurationsType": {
"base": "<p>Contains the parameters for DescribeNotificationConfigurations.</p>",
"base": null,
"refs": {
}
},
"DescribePoliciesType": {
"base": "<p>Contains the parameters for DescribePolicies.</p>",
"base": null,
"refs": {
}
},
"DescribeScalingActivitiesType": {
"base": "<p>Contains the parameters for DescribeScalingActivities.</p>",
"base": null,
"refs": {
}
},
"DescribeScheduledActionsType": {
"base": "<p>Contains the parameters for DescribeScheduledActions.</p>",
"base": null,
"refs": {
}
},
"DescribeTagsType": {
"base": "<p>Contains the parameters for DescribeTags.</p>",
"base": null,
"refs": {
}
},
"DescribeTerminationPolicyTypesAnswer": {
"base": "<p>Contains the output of DescribeTerminationPolicyTypes.</p>",
"base": null,
"refs": {
}
},
"DetachInstancesAnswer": {
"base": "<p>Contains the output of DetachInstances.</p>",
"base": null,
"refs": {
}
},
"DetachInstancesQuery": {
"base": "<p>Contains the parameters for DetachInstances.</p>",
"base": null,
"refs": {
}
},
@@ -496,24 +497,24 @@
}
},
"DetachLoadBalancersResultType": {
"base": "<p>Contains the output for DetachLoadBalancers.</p>",
"base": null,
"refs": {
}
},
"DetachLoadBalancersType": {
"base": "<p>Contains the parameters for DetachLoadBalancers.</p>",
"base": null,
"refs": {
}
},
"DisableMetricsCollectionQuery": {
"base": "<p>Contains the parameters for DisableMetricsCollection.</p>",
"base": null,
"refs": {
}
},
"DisableScaleIn": {
"base": null,
"refs": {
"TargetTrackingConfiguration$DisableScaleIn": "<p>If the parameter is true, then scale-in will be disabled for the target tracking policy, i.e. the target tracking policy will not scale in the Auto Scaling group. The default value is false.</p>"
"TargetTrackingConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking policy won't remove instances from the Auto Scaling group. Otherwise, scale in is enabled and the target tracking policy can remove instances from the Auto Scaling group. The default value is <code>false</code>.</p>"
}
},
"Ebs": {
@@ -530,7 +531,7 @@
}
},
"EnableMetricsCollectionQuery": {
"base": "<p>Contains the parameters for EnableMetricsCollection.</p>",
"base": null,
"refs": {
}
},
@@ -547,12 +548,12 @@
}
},
"EnterStandbyAnswer": {
"base": "<p>Contains the output of EnterStandby.</p>",
"base": null,
"refs": {
}
},
"EnterStandbyQuery": {
"base": "<p>Contains the parameters for EnteStandby.</p>",
"base": null,
"refs": {
}
},
@@ -564,17 +565,17 @@
}
},
"ExecutePolicyType": {
"base": "<p>Contains the parameters for ExecutePolicy.</p>",
"base": null,
"refs": {
}
},
"ExitStandbyAnswer": {
"base": "<p>Contains the parameters for ExitStandby.</p>",
"base": null,
"refs": {
}
},
"ExitStandbyQuery": {
"base": "<p>Contains the parameters for ExitStandby.</p>",
"base": null,
"refs": {
}
},
@@ -613,8 +614,9 @@
"HeartbeatTimeout": {
"base": null,
"refs": {
"LifecycleHook$HeartbeatTimeout": "<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. The default is 3600 seconds (1 hour). When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>",
"PutLifecycleHookType$HeartbeatTimeout": "<p>The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>. The default is 3600 seconds (1 hour).</p>"
"LifecycleHook$HeartbeatTimeout": "<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>",
"LifecycleHookSpecification$HeartbeatTimeout": "<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>",
"PutLifecycleHookType$HeartbeatTimeout": "<p>The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default is 3600 seconds (1 hour).</p> <p>If the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling <a>RecordLifecycleActionHeartbeat</a>.</p>"
}
},
"HonorCooldown": {
@@ -642,9 +644,9 @@
}
},
"InstanceMonitoring": {
"base": "<p>Describes whether instance monitoring is enabled.</p>",
"base": "<p>Describes whether detailed monitoring is enabled for the Auto Scaling instances.</p>",
"refs": {
"CreateLaunchConfigurationType$InstanceMonitoring": "<p>Enables detailed monitoring (<code>true</code>) or basic monitoring (<code>false</code>) for the Auto Scaling instances.</p>",
"CreateLaunchConfigurationType$InstanceMonitoring": "<p>Enables detailed monitoring (<code>true</code>) or basic monitoring (<code>false</code>) for the Auto Scaling instances. The default is <code>true</code>.</p>",
"LaunchConfiguration$InstanceMonitoring": "<p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring.</p>"
}
},
@@ -676,7 +678,7 @@
}
},
"LaunchConfigurationNameType": {
"base": "<p>Contains the parameters for DeleteLaunchConfiguration.</p>",
"base": null,
"refs": {
}
},
@@ -687,7 +689,7 @@
}
},
"LaunchConfigurationNamesType": {
"base": "<p>Contains the parameters for DescribeLaunchConfigurations.</p>",
"base": null,
"refs": {
}
},
@@ -698,7 +700,7 @@
}
},
"LaunchConfigurationsType": {
"base": "<p>Contains the output of DescribeLaunchConfigurations.</p>",
"base": null,
"refs": {
}
},
@@ -707,6 +709,7 @@
"refs": {
"CompleteLifecycleActionType$LifecycleActionResult": "<p>The action for the group to take. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>.</p>",
"LifecycleHook$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>",
"LifecycleHookSpecification$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>",
"PutLifecycleHookType$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>. The default value is <code>ABANDON</code>.</p>"
}
},
@@ -718,7 +721,7 @@
}
},
"LifecycleHook": {
"base": "<p>Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:</p> <ul> <li> <p>Pause the instance after it launches, but before it is put into service</p> </li> <li> <p>Pause the instance as it terminates, but before it is fully terminated</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>",
"base": "<p>Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p>",
"refs": {
"LifecycleHooks$member": null
}
@@ -729,6 +732,18 @@
"DescribeLifecycleHooksType$LifecycleHookNames": "<p>The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.</p>"
}
},
"LifecycleHookSpecification": {
"base": "<p>Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action whenever it launches instances or whenever it terminates instances.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/lifecycle-hooks.html\">Auto Scaling Lifecycle Hooks</a> in the <i>Auto Scaling User Guide</i>.</p>",
"refs": {
"LifecycleHookSpecifications$member": null
}
},
"LifecycleHookSpecifications": {
"base": null,
"refs": {
"CreateAutoScalingGroupType$LifecycleHookSpecificationList": "<p>One or more lifecycle hooks.</p>"
}
},
"LifecycleHooks": {
"base": null,
"refs": {
@@ -745,6 +760,7 @@
"base": null,
"refs": {
"LifecycleHook$LifecycleTransition": "<p>The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>.</p>",
"LifecycleHookSpecification$LifecycleTransition": "<p>The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>.</p>",
"PutLifecycleHookType$LifecycleTransition": "<p>The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see <a>DescribeLifecycleHookTypes</a>.</p> <p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>"
}
},
@@ -925,7 +941,7 @@
"MonitoringEnabled": {
"base": null,
"refs": {
"InstanceMonitoring$Enabled": "<p>If <code>True</code>, instance monitoring is enabled.</p>"
"InstanceMonitoring$Enabled": "<p>If <code>true</code>, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.</p>"
}
},
"NoDevice": {
@@ -949,6 +965,7 @@
"NotificationTargetResourceName": {
"base": null,
"refs": {
"LifecycleHookSpecification$NotificationTargetARN": "<p>The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>",
"PutLifecycleHookType$NotificationTargetARN": "<p>The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.</p> <p>This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.</p> <p>When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: <code>\"Event\": \"autoscaling:TEST_NOTIFICATION\"</code>.</p>"
}
},
@@ -965,7 +982,7 @@
}
},
"PoliciesType": {
"base": "<p>Contains the output of DescribePolicies.</p>",
"base": null,
"refs": {
}
},
@@ -995,7 +1012,7 @@
}
},
"PredefinedMetricSpecification": {
"base": "<p>Configures a predefined metric for a target tracking policy. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - average CPU utilization of the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - average number of bytes received on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - average number of bytes sent out on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - number of requests completed per target in an Application Load Balancer target group</p> </li> </ul>",
"base": "<p>Configures a predefined metric for a target tracking policy.</p>",
"refs": {
"TargetTrackingConfiguration$PredefinedMetricSpecification": "<p>A predefined metric. You can specify either a predefined metric or a customized metric.</p>"
}
@@ -1019,7 +1036,7 @@
}
},
"ProcessesType": {
"base": "<p>Contains the output of DescribeScalingProcessTypes.</p>",
"base": null,
"refs": {
}
},
@@ -1043,37 +1060,37 @@
}
},
"PutLifecycleHookAnswer": {
"base": "<p>Contains the output of PutLifecycleHook.</p>",
"base": null,
"refs": {
}
},
"PutLifecycleHookType": {
"base": "<p>Contains the parameters for PutLifecycleHook.</p>",
"base": null,
"refs": {
}
},
"PutNotificationConfigurationType": {
"base": "<p>Contains the parameters for PutNotificationConfiguration.</p>",
"base": null,
"refs": {
}
},
"PutScalingPolicyType": {
"base": "<p>Contains the parameters for PutScalingPolicy.</p>",
"base": null,
"refs": {
}
},
"PutScheduledUpdateGroupActionType": {
"base": "<p>Contains the parameters for PutScheduledUpdateGroupAction.</p>",
"base": null,
"refs": {
}
},
"RecordLifecycleActionHeartbeatAnswer": {
"base": "<p>Contains the output of RecordLifecycleActionHeartBeat.</p>",
"base": null,
"refs": {
}
},
"RecordLifecycleActionHeartbeatType": {
"base": "<p>Contains the parameters for RecordLifecycleActionHeartbeat.</p>",
"base": null,
"refs": {
}
},
@@ -1125,8 +1142,9 @@
"LaunchConfigurationNameType$LaunchConfigurationName": "<p>The name of the launch configuration.</p>",
"LaunchConfigurationNames$member": null,
"LifecycleHook$AutoScalingGroupName": "<p>The name of the Auto Scaling group for the lifecycle hook.</p>",
"LifecycleHook$NotificationTargetARN": "<p>The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:</p> <ul> <li> <p>Lifecycle action token</p> </li> <li> <p>User account ID</p> </li> <li> <p>Name of the Auto Scaling group</p> </li> <li> <p>Lifecycle hook name</p> </li> <li> <p>EC2 instance ID</p> </li> <li> <p>Lifecycle transition</p> </li> <li> <p>Notification metadata</p> </li> </ul>",
"LifecycleHook$NotificationTargetARN": "<p>The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>",
"LifecycleHook$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>",
"LifecycleHookSpecification$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>",
"NotificationConfiguration$AutoScalingGroupName": "<p>The name of the group.</p>",
"NotificationConfiguration$TopicARN": "<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>",
"PolicyARNType$PolicyARN": "<p>The Amazon Resource Name (ARN) of the policy.</p>",
@@ -1172,7 +1190,7 @@
}
},
"ScalingProcessQuery": {
"base": "<p>Contains the parameters for SuspendProcesses and ResumeProcesses.</p>",
"base": null,
"refs": {
}
},
@@ -1183,7 +1201,7 @@
}
},
"ScheduledActionsType": {
"base": "<p>Contains the output of DescribeScheduledActions.</p>",
"base": null,
"refs": {
}
},
@@ -1207,22 +1225,22 @@
}
},
"SetDesiredCapacityType": {
"base": "<p>Contains the parameters for SetDesiredCapacity.</p>",
"base": null,
"refs": {
}
},
"SetInstanceHealthQuery": {
"base": "<p>Contains the parameters for SetInstanceHealth.</p>",
"base": null,
"refs": {
}
},
"SetInstanceProtectionAnswer": {
"base": "<p>Contains the output of SetInstanceProtection.</p>",
"base": null,
"refs": {
}
},
"SetInstanceProtectionQuery": {
"base": "<p>Contains the parameters for SetInstanceProtection.</p>",
"base": null,
"refs": {
}
},
@@ -1314,7 +1332,7 @@
}
},
"TagsType": {
"base": "<p>Contains the output of DescribeTags.</p>",
"base": null,
"refs": {
}
},
@@ -1330,12 +1348,12 @@
"TargetTrackingConfiguration": {
"base": "<p>Represents a target tracking policy configuration.</p>",
"refs": {
"PutScalingPolicyType$TargetTrackingConfiguration": "<p>The configuration of a target tracking policy.</p> <p>This parameter is required if the policy type is <code>TargetTrackingScaling</code> and not supported otherwise.</p>",
"PutScalingPolicyType$TargetTrackingConfiguration": "<p>A target tracking policy.</p> <p>This parameter is required if the policy type is <code>TargetTrackingScaling</code> and not supported otherwise.</p>",
"ScalingPolicy$TargetTrackingConfiguration": "<p>A target tracking policy.</p>"
}
},
"TerminateInstanceInAutoScalingGroupType": {
"base": "<p>Contains the parameters for TerminateInstanceInAutoScalingGroup.</p>",
"base": null,
"refs": {
}
},
@@ -1366,7 +1384,7 @@
}
},
"UpdateAutoScalingGroupType": {
"base": "<p>Contains the parameters for UpdateAutoScalingGroup.</p>",
"base": null,
"refs": {
}
},
@@ -1417,7 +1435,8 @@
"refs": {
"Activity$Cause": "<p>The reason the activity began.</p>",
"LifecycleHook$NotificationMetadata": "<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>",
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code> and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>",
"LifecycleHookSpecification$NotificationMetadata": "<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>",
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - average CPU utilization of the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - average number of bytes received on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - average number of bytes sent out on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - number of requests completed per target in an Application Load Balancer target group</p> </li> </ul> <p>For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code> and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format: <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>",
"PutLifecycleHookType$NotificationMetadata": "<p>Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>"
}
},
@@ -1435,7 +1454,7 @@
"AutoScalingInstanceDetails$InstanceId": "<p>The ID of the instance.</p>",
"CompleteLifecycleActionType$InstanceId": "<p>The ID of the instance.</p>",
"CreateAutoScalingGroupType$InstanceId": "<p>The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
"CreateLaunchConfigurationType$InstanceId": "<p>The ID of the instance to use to create the launch configuration.</p> <p>The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
"CreateLaunchConfigurationType$InstanceId": "<p>The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>If you do not specify <code>InstanceId</code>, you must specify both <code>ImageId</code> and <code>InstanceType</code>.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
"Instance$InstanceId": "<p>The ID of the instance.</p>",
"InstanceIds$member": null,
"RecordLifecycleActionHeartbeatType$InstanceId": "<p>The ID of the instance.</p>",
@@ -1474,10 +1493,10 @@
"CreateAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the group. This name must be unique within the scope of your AWS account.</p>",
"CreateAutoScalingGroupType$PlacementGroup": "<p>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
"CreateLaunchConfigurationType$LaunchConfigurationName": "<p>The name of the launch configuration. This name must be unique within the scope of your AWS account.</p>",
"CreateLaunchConfigurationType$ImageId": "<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
"CreateLaunchConfigurationType$ImageId": "<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
"CreateLaunchConfigurationType$KeyName": "<p>The name of the key pair. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
"CreateLaunchConfigurationType$ClassicLinkVPCId": "<p>The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
"CreateLaunchConfigurationType$InstanceType": "<p>The instance type of the EC2 instance. For information about available instance types, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\"> Available Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> </p>",
"CreateLaunchConfigurationType$InstanceType": "<p>The instance type of the EC2 instance.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>InstanceType</code>.</p> <p>For information about available instance types, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\">Available Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> </p>",
"CreateLaunchConfigurationType$KernelId": "<p>The ID of the kernel associated with the AMI.</p>",
"CreateLaunchConfigurationType$RamdiskId": "<p>The ID of the RAM disk associated with the AMI.</p>",
"Ebs$SnapshotId": "<p>The ID of the snapshot.</p>",

6
vendor/github.com/aws/aws-sdk-go/models/apis/batch/2016-08-10/api-2.json generated vendored
View File

@@ -227,7 +227,8 @@
"containerInstanceArn":{"shape":"String"},
"taskArn":{"shape":"String"},
"exitCode":{"shape":"Integer"},
"reason":{"shape":"String"}
"reason":{"shape":"String"},
"logStreamName":{"shape":"String"}
}
},
"AttemptDetail":{
@@ -391,7 +392,8 @@
"exitCode":{"shape":"Integer"},
"reason":{"shape":"String"},
"containerInstanceArn":{"shape":"String"},
"taskArn":{"shape":"String"}
"taskArn":{"shape":"String"},
"logStreamName":{"shape":"String"}
}
},
"ContainerOverrides":{

32
vendor/github.com/aws/aws-sdk-go/models/apis/batch/2016-08-10/docs-2.json generated vendored
View File

@@ -3,16 +3,16 @@
"service": "<p>AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.</p> <p>As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.</p>",
"operations": {
"CancelJob": "<p>Cancels jobs in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> are not cancelled (but the API operation still succeeds, even if no jobs are cancelled); these jobs must be terminated with the <a>TerminateJob</a> operation.</p>",
"CreateComputeEnvironment": "<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>",
"CreateComputeEnvironment": "<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>",
"CreateJobQueue": "<p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.</p> <p>You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.</p>",
"DeleteComputeEnvironment": "<p>Deletes an AWS Batch compute environment.</p> <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation.</p>",
"DeleteJobQueue": "<p>Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation and terminate any jobs that have not completed with the <a>TerminateJob</a>.</p> <p>It is not necessary to disassociate compute environments from a queue before submitting a <code>DeleteJobQueue</code> request. </p>",
"DeleteJobQueue": "<p>Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation. All jobs in the queue are terminated when you delete a job queue.</p> <p>It is not necessary to disassociate compute environments from a queue before submitting a <code>DeleteJobQueue</code> request. </p>",
"DeregisterJobDefinition": "<p>Deregisters an AWS Batch job definition.</p>",
"DescribeComputeEnvironments": "<p>Describes one or more of your compute environments.</p> <p>If you are using an unmanaged compute environment, you can use the <code>DescribeComputeEnvironment</code> operation to determine the <code>ecsClusterArn</code> that you should launch your Amazon ECS container instances into.</p>",
"DescribeJobDefinitions": "<p>Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only return job definitions that match that status.</p>",
"DescribeJobQueues": "<p>Describes one or more of your job queues.</p>",
"DescribeJobs": "<p>Describes a list of AWS Batch jobs.</p>",
"ListJobs": "<p>Returns a list of task jobs for a specified job queue. You can filter the results by job status with the <code>jobStatus</code> parameter.</p>",
"ListJobs": "<p>Returns a list of task jobs for a specified job queue. You can filter the results by job status with the <code>jobStatus</code> parameter. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>",
"RegisterJobDefinition": "<p>Registers an AWS Batch job definition. </p>",
"SubmitJob": "<p>Submits an AWS Batch job from a job definition. Parameters specified during <a>SubmitJob</a> override parameters defined in the job definition. </p>",
"TerminateJob": "<p>Terminates jobs in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are cancelled.</p>",
@@ -269,9 +269,9 @@
"ContainerDetail$exitCode": "<p>The exit code to return upon completion.</p>",
"ContainerOverrides$vcpus": "<p>The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.</p>",
"ContainerOverrides$memory": "<p>The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.</p>",
"ContainerProperties$vcpus": "<p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares.</p>",
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"CreateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a lower integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of <code>1</code> is given scheduling preference over a job queue with a priority value of <code>10</code>.</p>",
"ContainerProperties$vcpus": "<p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least 1 vCPU.</p>",
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job.</p>",
"CreateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>",
"DescribeComputeEnvironmentsRequest$maxResults": "<p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</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>DescribeComputeEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeComputeEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"DescribeJobDefinitionsRequest$maxResults": "<p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</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>DescribeJobDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"DescribeJobQueuesRequest$maxResults": "<p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated output. When this parameter is used, <code>DescribeJobQueues</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>DescribeJobQueues</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeJobQueues</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
@@ -282,7 +282,7 @@
"RetryStrategy$attempts": "<p>The number of times to move a job to the <code>RUNNABLE</code> status. You may specify between 1 and 10 attempts. If <code>attempts</code> is greater than one, the job is retried if it fails until it has moved to <code>RUNNABLE</code> that many times.</p>",
"Ulimit$hardLimit": "<p>The hard limit for the <code>ulimit</code> type.</p>",
"Ulimit$softLimit": "<p>The soft limit for the <code>ulimit</code> type.</p>",
"UpdateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a lower integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of <code>1</code> is given scheduling preference over a job queue with a priority value of <code>10</code>.</p>"
"UpdateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>"
}
},
"JQState": {
@@ -327,7 +327,7 @@
"base": null,
"refs": {
"JobDetail$dependsOn": "<p>A list of job names or IDs on which this job depends.</p>",
"SubmitJobRequest$dependsOn": "<p>A list of job IDs on which this job depends. A job can depend upon a maximum of 100 jobs. </p>"
"SubmitJobRequest$dependsOn": "<p>A list of job IDs on which this job depends. A job can depend upon a maximum of 20 jobs. </p>"
}
},
"JobDetail": {
@@ -358,7 +358,7 @@
"base": null,
"refs": {
"JobDetail$status": "<p>The current status for the job.</p>",
"ListJobsRequest$jobStatus": "<p>The job status with which to filter jobs in the specified queue.</p>"
"ListJobsRequest$jobStatus": "<p>The job status with which to filter jobs in the specified queue. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>"
}
},
"JobSummary": {
@@ -451,6 +451,7 @@
"AttemptContainerDetail$containerInstanceArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.</p>",
"AttemptContainerDetail$taskArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt.</p>",
"AttemptContainerDetail$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
"AttemptContainerDetail$logStreamName": "<p>The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name when they reach the <code>RUNNING</code> status.</p>",
"AttemptDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job attempt.</p>",
"CancelJobRequest$jobId": "<p>A list of up to 100 job IDs to cancel.</p>",
"CancelJobRequest$reason": "<p>A message to attach to the job that explains the reason for cancelling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
@@ -463,7 +464,7 @@
"ComputeEnvironmentOrder$computeEnvironment": "<p>The Amazon Resource Name (ARN) of the compute environment.</p>",
"ComputeResource$imageId": "<p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.</p>",
"ComputeResource$ec2KeyPair": "<p>The EC2 key pair that is used for instances launched in the compute environment.</p>",
"ComputeResource$instanceRole": "<p>The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.</p>",
"ComputeResource$instanceRole": "<p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, <code>ecsInstanceRole</code> or <code>arn:aws:iam::&lt;aws_account_id&gt;:instance-profile/ecsInstanceRole</code>. For more information, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html\">Amazon ECS Instance Role</a> in the <i>AWS Batch User Guide</i>.</p>",
"ComputeResource$spotIamFleetRole": "<p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute environment.</p>",
"ContainerDetail$image": "<p>The image used to start the container.</p>",
"ContainerDetail$jobRoleArn": "<p>The Amazon Resource Name (ARN) associated with the job upon execution. </p>",
@@ -471,11 +472,12 @@
"ContainerDetail$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
"ContainerDetail$containerInstanceArn": "<p>The Amazon Resource Name (ARN) of the container instance on which the container is running.</p>",
"ContainerDetail$taskArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.</p>",
"ContainerDetail$logStreamName": "<p>The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name when they reach the <code>RUNNING</code> status.</p>",
"ContainerProperties$image": "<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>Images in Amazon ECR repositories use the full registry and repository URI (for example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;</code>). </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>",
"ContainerProperties$jobRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.</p>",
"ContainerProperties$user": "<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"CreateComputeEnvironmentRequest$computeEnvironmentName": "<p>The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.</p>",
"CreateComputeEnvironmentRequest$serviceRole": "<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. </p>",
"CreateComputeEnvironmentRequest$serviceRole": "<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN may contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>",
"CreateComputeEnvironmentResponse$computeEnvironmentName": "<p>The name of the compute environment.</p>",
"CreateComputeEnvironmentResponse$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
"CreateJobQueueRequest$jobQueueName": "<p>The name of the job queue.</p>",
@@ -517,12 +519,12 @@
"MountPoint$sourceVolume": "<p>The name of the volume to mount.</p>",
"ParametersMap$key": null,
"ParametersMap$value": null,
"RegisterJobDefinitionRequest$jobDefinitionName": "<p>The name of the job definition to register. </p>",
"RegisterJobDefinitionResponse$jobDefinitionName": "<p>The name of the job definition. </p>",
"RegisterJobDefinitionRequest$jobDefinitionName": "<p>The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p>",
"RegisterJobDefinitionResponse$jobDefinitionName": "<p>The name of the job definition.</p>",
"RegisterJobDefinitionResponse$jobDefinitionArn": "<p>The Amazon Resource Name (ARN) of the job definition. </p>",
"ServerException$message": null,
"StringList$member": null,
"SubmitJobRequest$jobName": "<p>The name of the job. A name must be 1 to 128 characters in length.</p> <p>Pattern: ^[a-zA-Z0-9_]+$</p>",
"SubmitJobRequest$jobName": "<p>The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. </p>",
"SubmitJobRequest$jobQueue": "<p>The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue. </p>",
"SubmitJobRequest$jobDefinition": "<p>The job definition used by this job. This value can be either a <code>name:revision</code> or the Amazon Resource Name (ARN) for the job definition.</p>",
"SubmitJobResponse$jobName": "<p>The name of the job. </p>",
@@ -533,7 +535,7 @@
"TerminateJobRequest$reason": "<p>A message to attach to the job that explains the reason for cancelling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
"Ulimit$name": "<p>The <code>type</code> of the <code>ulimit</code>.</p>",
"UpdateComputeEnvironmentRequest$computeEnvironment": "<p>The name or full Amazon Resource Name (ARN) of the compute environment to update.</p>",
"UpdateComputeEnvironmentRequest$serviceRole": "<p>The name or full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to ECS, Auto Scaling, and EC2 on your behalf.</p>",
"UpdateComputeEnvironmentRequest$serviceRole": "<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN may contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>",
"UpdateComputeEnvironmentResponse$computeEnvironmentName": "<p>The name of compute environment.</p>",
"UpdateComputeEnvironmentResponse$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
"UpdateJobQueueRequest$jobQueue": "<p>The name or the Amazon Resource Name (ARN) of the job queue.</p>",

4
vendor/github.com/aws/aws-sdk-go/models/apis/batch/2016-08-10/examples-1.json generated vendored
View File

@@ -124,7 +124,7 @@
}
],
"jobQueueName": "LowPriority",
"priority": 10,
"priority": 1,
"state": "ENABLED"
},
"output": {
@@ -154,7 +154,7 @@
}
],
"jobQueueName": "HighPriority",
"priority": 1,
"priority": 10,
"state": "ENABLED"
},
"output": {

18
vendor/github.com/aws/aws-sdk-go/models/apis/budgets/2016-10-20/api-2.json generated vendored
View File

@@ -188,7 +188,8 @@
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"}
]
},
"UpdateSubscriber":{
@@ -202,7 +203,8 @@
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"}
]
}
},
@@ -542,12 +544,13 @@
"members":{
"NotificationType":{"shape":"NotificationType"},
"ComparisonOperator":{"shape":"ComparisonOperator"},
"Threshold":{"shape":"NotificationThreshold"}
"Threshold":{"shape":"NotificationThreshold"},
"ThresholdType":{"shape":"ThresholdType"}
}
},
"NotificationThreshold":{
"type":"double",
"max":300,
"max":1000000000,
"min":0.1
},
"NotificationType":{
@@ -616,6 +619,13 @@
"EMAIL"
]
},
"ThresholdType":{
"type":"string",
"enum":[
"PERCENTAGE",
"ABSOLUTE_VALUE"
]
},
"TimePeriod":{
"type":"structure",
"required":[

18
vendor/github.com/aws/aws-sdk-go/models/apis/budgets/2016-10-20/docs-2.json generated vendored
View File

@@ -73,7 +73,7 @@
}
},
"CalculatedSpend": {
"base": "A structure holds the actual and forecasted spend for a budget.",
"base": "A structure that holds the actual and forecasted spend for a budget.",
"refs": {
"Budget$CalculatedSpend": null
}
@@ -85,7 +85,7 @@
}
},
"CostFilters": {
"base": "A map represents the cost filters applied to the budget.",
"base": "A map that represents the cost filters applied to the budget.",
"refs": {
"Budget$CostFilters": null
}
@@ -262,7 +262,7 @@
}
},
"MaxResults": {
"base": "An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.",
"base": "An integer to represent how many entries a paginated response contains. Maximum is set to 100.",
"refs": {
"DescribeBudgetsRequest$MaxResults": null,
"DescribeNotificationsForBudgetRequest$MaxResults": null,
@@ -290,7 +290,7 @@
}
},
"NotificationThreshold": {
"base": "The threshold of the a notification. It should be a number between 0 and 100.",
"base": "The threshold of a notification. It should be a number between 0 and 1,000,000,000.",
"refs": {
"Notification$Threshold": null
}
@@ -326,7 +326,7 @@
}
},
"Spend": {
"base": "A structure represent either a cost spend or usage spend. Contains an amount and a unit.",
"base": "A structure that represents either a cost spend or usage spend. Contains an amount and a unit.",
"refs": {
"Budget$BudgetLimit": null,
"CalculatedSpend$ActualSpend": null,
@@ -357,8 +357,14 @@
"Subscriber$SubscriptionType": null
}
},
"ThresholdType": {
"base": "The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.",
"refs": {
"Notification$ThresholdType": null
}
},
"TimePeriod": {
"base": "A time period indicated the start date and end date of a budget.",
"base": "A time period indicating the start date and end date of a budget.",
"refs": {
"Budget$TimePeriod": null
}

329
vendor/github.com/aws/aws-sdk-go/models/apis/clouddirectory/2016-05-10/api-2.json generated vendored
View File

@@ -136,6 +136,7 @@
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"},
{"shape":"ValidationException"},
@@ -495,6 +496,7 @@
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
]
@@ -774,6 +776,7 @@
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"FacetValidationException"}
@@ -927,6 +930,7 @@
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"FacetValidationException"}
@@ -1494,6 +1498,80 @@
"attachedObjectIdentifier":{"shape":"ObjectIdentifier"}
}
},
"BatchAttachPolicy":{
"type":"structure",
"required":[
"PolicyReference",
"ObjectReference"
],
"members":{
"PolicyReference":{"shape":"ObjectReference"},
"ObjectReference":{"shape":"ObjectReference"}
}
},
"BatchAttachPolicyResponse":{
"type":"structure",
"members":{
}
},
"BatchAttachToIndex":{
"type":"structure",
"required":[
"IndexReference",
"TargetReference"
],
"members":{
"IndexReference":{"shape":"ObjectReference"},
"TargetReference":{"shape":"ObjectReference"}
}
},
"BatchAttachToIndexResponse":{
"type":"structure",
"members":{
"AttachedObjectIdentifier":{"shape":"ObjectIdentifier"}
}
},
"BatchAttachTypedLink":{
"type":"structure",
"required":[
"SourceObjectReference",
"TargetObjectReference",
"TypedLinkFacet",
"Attributes"
],
"members":{
"SourceObjectReference":{"shape":"ObjectReference"},
"TargetObjectReference":{"shape":"ObjectReference"},
"TypedLinkFacet":{"shape":"TypedLinkSchemaAndFacetName"},
"Attributes":{"shape":"AttributeNameAndValueList"}
}
},
"BatchAttachTypedLinkResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifier":{"shape":"TypedLinkSpecifier"}
}
},
"BatchCreateIndex":{
"type":"structure",
"required":[
"OrderedIndexedAttributeList",
"IsUnique"
],
"members":{
"OrderedIndexedAttributeList":{"shape":"AttributeKeyList"},
"IsUnique":{"shape":"Bool"},
"ParentReference":{"shape":"ObjectReference"},
"LinkName":{"shape":"LinkName"},
"BatchReferenceName":{"shape":"BatchReferenceName"}
}
},
"BatchCreateIndexResponse":{
"type":"structure",
"members":{
"ObjectIdentifier":{"shape":"ObjectIdentifier"}
}
},
"BatchCreateObject":{
"type":"structure",
"required":[
@@ -1529,6 +1607,23 @@
"members":{
}
},
"BatchDetachFromIndex":{
"type":"structure",
"required":[
"IndexReference",
"TargetReference"
],
"members":{
"IndexReference":{"shape":"ObjectReference"},
"TargetReference":{"shape":"ObjectReference"}
}
},
"BatchDetachFromIndexResponse":{
"type":"structure",
"members":{
"DetachedObjectIdentifier":{"shape":"ObjectIdentifier"}
}
},
"BatchDetachObject":{
"type":"structure",
"required":[
@@ -1548,6 +1643,99 @@
"detachedObjectIdentifier":{"shape":"ObjectIdentifier"}
}
},
"BatchDetachPolicy":{
"type":"structure",
"required":[
"PolicyReference",
"ObjectReference"
],
"members":{
"PolicyReference":{"shape":"ObjectReference"},
"ObjectReference":{"shape":"ObjectReference"}
}
},
"BatchDetachPolicyResponse":{
"type":"structure",
"members":{
}
},
"BatchDetachTypedLink":{
"type":"structure",
"required":["TypedLinkSpecifier"],
"members":{
"TypedLinkSpecifier":{"shape":"TypedLinkSpecifier"}
}
},
"BatchDetachTypedLinkResponse":{
"type":"structure",
"members":{
}
},
"BatchGetObjectInformation":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{"shape":"ObjectReference"}
}
},
"BatchGetObjectInformationResponse":{
"type":"structure",
"members":{
"SchemaFacets":{"shape":"SchemaFacetList"},
"ObjectIdentifier":{"shape":"ObjectIdentifier"}
}
},
"BatchListAttachedIndices":{
"type":"structure",
"required":["TargetReference"],
"members":{
"TargetReference":{"shape":"ObjectReference"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
},
"BatchListAttachedIndicesResponse":{
"type":"structure",
"members":{
"IndexAttachments":{"shape":"IndexAttachmentList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchListIncomingTypedLinks":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{"shape":"ObjectReference"},
"FilterAttributeRanges":{"shape":"TypedLinkAttributeRangeList"},
"FilterTypedLink":{"shape":"TypedLinkSchemaAndFacetName"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
},
"BatchListIncomingTypedLinksResponse":{
"type":"structure",
"members":{
"LinkSpecifiers":{"shape":"TypedLinkSpecifierList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchListIndex":{
"type":"structure",
"required":["IndexReference"],
"members":{
"RangesOnIndexedValues":{"shape":"ObjectAttributeRangeList"},
"IndexReference":{"shape":"ObjectReference"},
"MaxResults":{"shape":"NumberResults"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchListIndexResponse":{
"type":"structure",
"members":{
"IndexAttachments":{"shape":"IndexAttachmentList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchListObjectAttributes":{
"type":"structure",
"required":["ObjectReference"],
@@ -1581,6 +1769,88 @@
"NextToken":{"shape":"NextToken"}
}
},
"BatchListObjectParentPaths":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{"shape":"ObjectReference"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
},
"BatchListObjectParentPathsResponse":{
"type":"structure",
"members":{
"PathToObjectIdentifiersList":{"shape":"PathToObjectIdentifiersList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchListObjectPolicies":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{"shape":"ObjectReference"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
},
"BatchListObjectPoliciesResponse":{
"type":"structure",
"members":{
"AttachedPolicyIds":{"shape":"ObjectIdentifierList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchListOutgoingTypedLinks":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{"shape":"ObjectReference"},
"FilterAttributeRanges":{"shape":"TypedLinkAttributeRangeList"},
"FilterTypedLink":{"shape":"TypedLinkSchemaAndFacetName"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
},
"BatchListOutgoingTypedLinksResponse":{
"type":"structure",
"members":{
"TypedLinkSpecifiers":{"shape":"TypedLinkSpecifierList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchListPolicyAttachments":{
"type":"structure",
"required":["PolicyReference"],
"members":{
"PolicyReference":{"shape":"ObjectReference"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
},
"BatchListPolicyAttachmentsResponse":{
"type":"structure",
"members":{
"ObjectIdentifiers":{"shape":"ObjectIdentifierList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchLookupPolicy":{
"type":"structure",
"required":["ObjectReference"],
"members":{
"ObjectReference":{"shape":"ObjectReference"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
},
"BatchLookupPolicyResponse":{
"type":"structure",
"members":{
"PolicyToPathList":{"shape":"PolicyToPathList"},
"NextToken":{"shape":"NextToken"}
}
},
"BatchOperationIndex":{"type":"integer"},
"BatchReadException":{
"type":"structure",
@@ -1597,14 +1867,30 @@
"ResourceNotFoundException",
"InvalidNextTokenException",
"AccessDeniedException",
"NotNodeException"
"NotNodeException",
"FacetValidationException",
"CannotListParentOfRootException",
"NotIndexException",
"NotPolicyException",
"DirectoryNotEnabledException",
"LimitExceededException",
"InternalServiceException"
]
},
"BatchReadOperation":{
"type":"structure",
"members":{
"ListObjectAttributes":{"shape":"BatchListObjectAttributes"},
"ListObjectChildren":{"shape":"BatchListObjectChildren"}
"ListObjectChildren":{"shape":"BatchListObjectChildren"},
"ListAttachedIndices":{"shape":"BatchListAttachedIndices"},
"ListObjectParentPaths":{"shape":"BatchListObjectParentPaths"},
"GetObjectInformation":{"shape":"BatchGetObjectInformation"},
"ListObjectPolicies":{"shape":"BatchListObjectPolicies"},
"ListPolicyAttachments":{"shape":"BatchListPolicyAttachments"},
"LookupPolicy":{"shape":"BatchLookupPolicy"},
"ListIndex":{"shape":"BatchListIndex"},
"ListOutgoingTypedLinks":{"shape":"BatchListOutgoingTypedLinks"},
"ListIncomingTypedLinks":{"shape":"BatchListIncomingTypedLinks"}
}
},
"BatchReadOperationList":{
@@ -1652,7 +1938,16 @@
"type":"structure",
"members":{
"ListObjectAttributes":{"shape":"BatchListObjectAttributesResponse"},
"ListObjectChildren":{"shape":"BatchListObjectChildrenResponse"}
"ListObjectChildren":{"shape":"BatchListObjectChildrenResponse"},
"GetObjectInformation":{"shape":"BatchGetObjectInformationResponse"},
"ListAttachedIndices":{"shape":"BatchListAttachedIndicesResponse"},
"ListObjectParentPaths":{"shape":"BatchListObjectParentPathsResponse"},
"ListObjectPolicies":{"shape":"BatchListObjectPoliciesResponse"},
"ListPolicyAttachments":{"shape":"BatchListPolicyAttachmentsResponse"},
"LookupPolicy":{"shape":"BatchLookupPolicyResponse"},
"ListIndex":{"shape":"BatchListIndexResponse"},
"ListOutgoingTypedLinks":{"shape":"BatchListOutgoingTypedLinksResponse"},
"ListIncomingTypedLinks":{"shape":"BatchListIncomingTypedLinksResponse"}
}
},
"BatchReferenceName":{"type":"string"},
@@ -1709,7 +2004,15 @@
"FacetValidationException",
"ObjectNotDetachedException",
"ResourceNotFoundException",
"AccessDeniedException"
"AccessDeniedException",
"InvalidAttachmentException",
"NotIndexException",
"IndexedAttributeMissingException",
"ObjectAlreadyDetachedException",
"NotPolicyException",
"DirectoryNotEnabledException",
"LimitExceededException",
"UnsupportedIndexTypeException"
]
},
"BatchWriteOperation":{
@@ -1721,7 +2024,14 @@
"UpdateObjectAttributes":{"shape":"BatchUpdateObjectAttributes"},
"DeleteObject":{"shape":"BatchDeleteObject"},
"AddFacetToObject":{"shape":"BatchAddFacetToObject"},
"RemoveFacetFromObject":{"shape":"BatchRemoveFacetFromObject"}
"RemoveFacetFromObject":{"shape":"BatchRemoveFacetFromObject"},
"AttachPolicy":{"shape":"BatchAttachPolicy"},
"DetachPolicy":{"shape":"BatchDetachPolicy"},
"CreateIndex":{"shape":"BatchCreateIndex"},
"AttachToIndex":{"shape":"BatchAttachToIndex"},
"DetachFromIndex":{"shape":"BatchDetachFromIndex"},
"AttachTypedLink":{"shape":"BatchAttachTypedLink"},
"DetachTypedLink":{"shape":"BatchDetachTypedLink"}
}
},
"BatchWriteOperationList":{
@@ -1737,7 +2047,14 @@
"UpdateObjectAttributes":{"shape":"BatchUpdateObjectAttributesResponse"},
"DeleteObject":{"shape":"BatchDeleteObjectResponse"},
"AddFacetToObject":{"shape":"BatchAddFacetToObjectResponse"},
"RemoveFacetFromObject":{"shape":"BatchRemoveFacetFromObjectResponse"}
"RemoveFacetFromObject":{"shape":"BatchRemoveFacetFromObjectResponse"},
"AttachPolicy":{"shape":"BatchAttachPolicyResponse"},
"DetachPolicy":{"shape":"BatchDetachPolicyResponse"},
"CreateIndex":{"shape":"BatchCreateIndexResponse"},
"AttachToIndex":{"shape":"BatchAttachToIndexResponse"},
"DetachFromIndex":{"shape":"BatchDetachFromIndexResponse"},
"AttachTypedLink":{"shape":"BatchAttachTypedLinkResponse"},
"DetachTypedLink":{"shape":"BatchDetachTypedLinkResponse"}
}
},
"BatchWriteOperationResponseList":{

290
vendor/github.com/aws/aws-sdk-go/models/apis/clouddirectory/2016-05-10/docs-2.json generated vendored
View File

@@ -241,6 +241,7 @@
"AttributeKeyList": {
"base": null,
"refs": {
"BatchCreateIndex$OrderedIndexedAttributeList": "<p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>",
"CreateIndexRequest$OrderedIndexedAttributeList": "<p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>"
}
},
@@ -266,6 +267,7 @@
"base": null,
"refs": {
"AttachTypedLinkRequest$Attributes": "<p>A set of attributes that are associated with the typed link.</p>",
"BatchAttachTypedLink$Attributes": "<p>A set of attributes that are associated with the typed link.</p>",
"TypedLinkSpecifier$IdentityAttributeValues": "<p>Identifies the attribute value to update.</p>"
}
},
@@ -273,7 +275,7 @@
"base": null,
"refs": {
"GetTypedLinkFacetInformationResponse$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"TypedLinkFacet$IdentityAttributeOrder": "<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypeLinks</a> for details.</p>",
"TypedLinkFacet$IdentityAttributeOrder": "<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>",
"UpdateTypedLinkFacetRequest$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
@@ -290,77 +292,269 @@
}
},
"BatchAttachObject": {
"base": "<p>Represents the output of an <code>AttachObject</code> operation.</p>",
"base": "<p>Represents the output of an <a>AttachObject</a> operation.</p>",
"refs": {
"BatchWriteOperation$AttachObject": "<p>Attaches an object to a <a>Directory</a>.</p>"
}
},
"BatchAttachObjectResponse": {
"base": "<p>Represents the output batch <code>AttachObject</code> response operation.</p>",
"base": "<p>Represents the output batch <a>AttachObject</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$AttachObject": "<p>Attaches an object to a <a>Directory</a>.</p>"
}
},
"BatchAttachPolicy": {
"base": "<p>Attaches a policy object to a regular object inside a <a>BatchRead</a> operation. For more information, see <a>AttachPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$AttachPolicy": "<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
}
},
"BatchAttachPolicyResponse": {
"base": "<p>Represents the output of an <a>AttachPolicy</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$AttachPolicy": "<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>"
}
},
"BatchAttachToIndex": {
"base": "<p>Attaches the specified object to the specified index inside a <a>BatchRead</a> operation. For more information, see <a>AttachToIndex</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$AttachToIndex": "<p>Attaches the specified object to the specified index.</p>"
}
},
"BatchAttachToIndexResponse": {
"base": "<p>Represents the output of a <a>AttachToIndex</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$AttachToIndex": "<p>Attaches the specified object to the specified index.</p>"
}
},
"BatchAttachTypedLink": {
"base": "<p>Attaches a typed link to a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>AttachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchAttachTypedLinkResponse": {
"base": "<p>Represents the output of a <a>AttachTypedLink</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchCreateIndex": {
"base": "<p>Creates an index object inside of a <a>BatchRead</a> operation. For more information, see <a>CreateIndex</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$CreateIndex": "<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
}
},
"BatchCreateIndexResponse": {
"base": "<p>Represents the output of a <a>CreateIndex</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$CreateIndex": "<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
}
},
"BatchCreateObject": {
"base": "<p>Represents the output of a <code>CreateObject</code> operation.</p>",
"base": "<p>Represents the output of a <a>CreateObject</a> operation.</p>",
"refs": {
"BatchWriteOperation$CreateObject": "<p>Creates an object.</p>"
}
},
"BatchCreateObjectResponse": {
"base": "<p>Represents the output of a <code>CreateObject</code> response operation.</p>",
"base": "<p>Represents the output of a <a>CreateObject</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$CreateObject": "<p>Creates an object in a <a>Directory</a>.</p>"
}
},
"BatchDeleteObject": {
"base": "<p>Represents the output of a <code>DeleteObject</code> operation.</p>",
"base": "<p>Represents the output of a <a>DeleteObject</a> operation.</p>",
"refs": {
"BatchWriteOperation$DeleteObject": "<p>Deletes an object in a <a>Directory</a>.</p>"
}
},
"BatchDeleteObjectResponse": {
"base": "<p>Represents the output of a <code>DeleteObject</code> response operation.</p>",
"base": "<p>Represents the output of a <a>DeleteObject</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$DeleteObject": "<p>Deletes an object in a <a>Directory</a>.</p>"
}
},
"BatchDetachFromIndex": {
"base": "<p>Detaches the specified object from the specified index inside a <a>BatchRead</a> operation. For more information, see <a>DetachFromIndex</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$DetachFromIndex": "<p>Detaches the specified object from the specified index.</p>"
}
},
"BatchDetachFromIndexResponse": {
"base": "<p>Represents the output of a <a>DetachFromIndex</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$DetachFromIndex": "<p>Detaches the specified object from the specified index.</p>"
}
},
"BatchDetachObject": {
"base": "<p>Represents the output of a <code>DetachObject</code> operation.</p>",
"base": "<p>Represents the output of a <a>DetachObject</a> operation.</p>",
"refs": {
"BatchWriteOperation$DetachObject": "<p>Detaches an object from a <a>Directory</a>.</p>"
}
},
"BatchDetachObjectResponse": {
"base": "<p>Represents the output of a <code>DetachObject</code> response operation.</p>",
"base": "<p>Represents the output of a <a>DetachObject</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$DetachObject": "<p>Detaches an object from a <a>Directory</a>.</p>"
}
},
"BatchDetachPolicy": {
"base": "<p>Detaches the specified policy from the specified directory inside a <a>BatchRead</a> operation. For more information, see <a>DetachPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$DetachPolicy": "<p>Detaches a policy from a <a>Directory</a>.</p>"
}
},
"BatchDetachPolicyResponse": {
"base": "<p>Represents the output of a <a>DetachPolicy</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$DetachPolicy": "<p>Detaches a policy from a <a>Directory</a>.</p>"
}
},
"BatchDetachTypedLink": {
"base": "<p>Detaches a typed link from a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>DetachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchDetachTypedLinkResponse": {
"base": "<p>Represents the output of a <a>DetachTypedLink</a> response operation.</p>",
"refs": {
"BatchWriteOperationResponse$DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchGetObjectInformation": {
"base": "<p>Retrieves metadata about an object inside a <a>BatchRead</a> operation. For more information, see <a>GetObjectInformation</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$GetObjectInformation": "<p>Retrieves metadata about an object.</p>"
}
},
"BatchGetObjectInformationResponse": {
"base": "<p>Represents the output of a <a>GetObjectInformation</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$GetObjectInformation": "<p>Retrieves metadata about an object.</p>"
}
},
"BatchListAttachedIndices": {
"base": "<p>Lists indices attached to an object inside a <a>BatchRead</a> operation. For more information, see <a>ListAttachedIndices</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$ListAttachedIndices": "<p>Lists indices attached to an object.</p>"
}
},
"BatchListAttachedIndicesResponse": {
"base": "<p>Represents the output of a <a>ListAttachedIndices</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListAttachedIndices": "<p>Lists indices attached to an object.</p>"
}
},
"BatchListIncomingTypedLinks": {
"base": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListIncomingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchListIncomingTypedLinksResponse": {
"base": "<p>Represents the output of a <a>ListIncomingTypedLinks</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchListIndex": {
"base": "<p>Lists objects attached to the specified index inside a <a>BatchRead</a> operation. For more information, see <a>ListIndex</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$ListIndex": "<p>Lists objects attached to the specified index.</p>"
}
},
"BatchListIndexResponse": {
"base": "<p>Represents the output of a <a>ListIndex</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListIndex": "<p>Lists objects attached to the specified index.</p>"
}
},
"BatchListObjectAttributes": {
"base": "<p>Represents the output of a <code>ListObjectAttributes</code> operation.</p>",
"base": "<p>Represents the output of a <a>ListObjectAttributes</a> operation.</p>",
"refs": {
"BatchReadOperation$ListObjectAttributes": "<p>Lists all attributes that are associated with an object.</p>"
}
},
"BatchListObjectAttributesResponse": {
"base": "<p>Represents the output of a <code>ListObjectAttributes</code> response operation.</p>",
"base": "<p>Represents the output of a <a>ListObjectAttributes</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListObjectAttributes": "<p>Lists all attributes that are associated with an object.</p>"
}
},
"BatchListObjectChildren": {
"base": "<p>Represents the output of a <code>ListObjectChildren</code> operation.</p>",
"base": "<p>Represents the output of a <a>ListObjectChildren</a> operation.</p>",
"refs": {
"BatchReadOperation$ListObjectChildren": "<p>Returns a paginated list of child objects that are associated with a given object.</p>"
}
},
"BatchListObjectChildrenResponse": {
"base": "<p>Represents the output of a <code>ListObjectChildren</code> response operation.</p>",
"base": "<p>Represents the output of a <a>ListObjectChildren</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListObjectChildren": "<p>Returns a paginated list of child objects that are associated with a given object.</p>"
}
},
"BatchListObjectParentPaths": {
"base": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a <a>BatchRead</a> operation. For more information, see <a>ListObjectParentPaths</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
}
},
"BatchListObjectParentPathsResponse": {
"base": "<p>Represents the output of a <a>ListObjectParentPaths</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
}
},
"BatchListObjectPolicies": {
"base": "<p>Returns policies attached to an object in pagination fashion inside a <a>BatchRead</a> operation. For more information, see <a>ListObjectPolicies</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$ListObjectPolicies": "<p>Returns policies attached to an object in pagination fashion.</p>"
}
},
"BatchListObjectPoliciesResponse": {
"base": "<p>Represents the output of a <a>ListObjectPolicies</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListObjectPolicies": "<p>Returns policies attached to an object in pagination fashion.</p>"
}
},
"BatchListOutgoingTypedLinks": {
"base": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListOutgoingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchListOutgoingTypedLinksResponse": {
"base": "<p>Represents the output of a <a>ListOutgoingTypedLinks</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
}
},
"BatchListPolicyAttachments": {
"base": "<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached inside a <a>BatchRead</a> operation. For more information, see <a>ListPolicyAttachments</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$ListPolicyAttachments": "<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
}
},
"BatchListPolicyAttachmentsResponse": {
"base": "<p>Represents the output of a <a>ListPolicyAttachments</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$ListPolicyAttachments": "<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
}
},
"BatchLookupPolicy": {
"base": "<p>Lists all policies from the root of the Directory to the object specified inside a <a>BatchRead</a> operation. For more information, see <a>LookupPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
}
},
"BatchLookupPolicyResponse": {
"base": "<p>Represents the output of a <a>LookupPolicy</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
}
},
"BatchOperationIndex": {
"base": null,
"refs": {
@@ -422,6 +616,7 @@
"BatchReferenceName": {
"base": null,
"refs": {
"BatchCreateIndex$BatchReferenceName": "<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>",
"BatchCreateObject$BatchReferenceName": "<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>",
"BatchDetachObject$BatchReferenceName": "<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
}
@@ -504,6 +699,7 @@
"Bool": {
"base": null,
"refs": {
"BatchCreateIndex$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
"CreateIndexRequest$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
"FacetAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>",
"TypedLinkAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>"
@@ -960,6 +1156,8 @@
"IndexAttachmentList": {
"base": null,
"refs": {
"BatchListAttachedIndicesResponse$IndexAttachments": "<p>The indices attached to the specified object.</p>",
"BatchListIndexResponse$IndexAttachments": "<p>The objects and indexed values attached to the index.</p>",
"ListAttachedIndicesResponse$IndexAttachments": "<p>The indices attached to the specified object.</p>",
"ListIndexResponse$IndexAttachments": "<p>The objects and indexed values attached to the index.</p>"
}
@@ -1019,6 +1217,7 @@
"refs": {
"AttachObjectRequest$LinkName": "<p>The link name with which the child object is attached to the parent.</p>",
"BatchAttachObject$LinkName": "<p>The name of the link.</p>",
"BatchCreateIndex$LinkName": "<p>The name of the link between the parent object and the index object.</p>",
"BatchCreateObject$LinkName": "<p>The name of the link.</p>",
"BatchDetachObject$LinkName": "<p>The name of the link.</p>",
"CreateIndexRequest$LinkName": "<p>The name of the link between the parent object and the index object.</p>",
@@ -1243,10 +1442,26 @@
"NextToken": {
"base": null,
"refs": {
"BatchListAttachedIndices$NextToken": "<p>The pagination token.</p>",
"BatchListAttachedIndicesResponse$NextToken": "<p>The pagination token.</p>",
"BatchListIncomingTypedLinks$NextToken": "<p>The pagination token.</p>",
"BatchListIncomingTypedLinksResponse$NextToken": "<p>The pagination token.</p>",
"BatchListIndex$NextToken": "<p>The pagination token.</p>",
"BatchListIndexResponse$NextToken": "<p>The pagination token.</p>",
"BatchListObjectAttributes$NextToken": "<p>The pagination token.</p>",
"BatchListObjectAttributesResponse$NextToken": "<p>The pagination token.</p>",
"BatchListObjectChildren$NextToken": "<p>The pagination token.</p>",
"BatchListObjectChildrenResponse$NextToken": "<p>The pagination token.</p>",
"BatchListObjectParentPaths$NextToken": "<p>The pagination token.</p>",
"BatchListObjectParentPathsResponse$NextToken": "<p>The pagination token.</p>",
"BatchListObjectPolicies$NextToken": "<p>The pagination token.</p>",
"BatchListObjectPoliciesResponse$NextToken": "<p>The pagination token.</p>",
"BatchListOutgoingTypedLinks$NextToken": "<p>The pagination token.</p>",
"BatchListOutgoingTypedLinksResponse$NextToken": "<p>The pagination token.</p>",
"BatchListPolicyAttachments$NextToken": "<p>The pagination token.</p>",
"BatchListPolicyAttachmentsResponse$NextToken": "<p>The pagination token.</p>",
"BatchLookupPolicy$NextToken": "<p>The pagination token.</p>",
"BatchLookupPolicyResponse$NextToken": "<p>The pagination token.</p>",
"ListAppliedSchemaArnsRequest$NextToken": "<p>The pagination token.</p>",
"ListAppliedSchemaArnsResponse$NextToken": "<p>The pagination token.</p>",
"ListAttachedIndicesRequest$NextToken": "<p>The pagination token.</p>",
@@ -1313,8 +1528,16 @@
"NumberResults": {
"base": null,
"refs": {
"BatchListAttachedIndices$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"BatchListIncomingTypedLinks$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"BatchListIndex$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"BatchListObjectAttributes$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
"BatchListObjectChildren$MaxResults": "<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
"BatchListObjectParentPaths$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"BatchListObjectPolicies$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"BatchListOutgoingTypedLinks$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"BatchListPolicyAttachments$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"BatchLookupPolicy$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"ListAppliedSchemaArnsRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"ListAttachedIndicesRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"ListDevelopmentSchemaArnsRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
@@ -1356,6 +1579,7 @@
"ObjectAttributeRangeList": {
"base": null,
"refs": {
"BatchListIndex$RangesOnIndexedValues": "<p>Specifies the ranges of indexed values that you want to query.</p>",
"ListIndexRequest$RangesOnIndexedValues": "<p>Specifies the ranges of indexed values that you want to query.</p>"
}
},
@@ -1378,8 +1602,12 @@
"AttachObjectResponse$AttachedObjectIdentifier": "<p>The attached <code>ObjectIdentifier</code>, which is the child <code>ObjectIdentifier</code>.</p>",
"AttachToIndexResponse$AttachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>",
"BatchAttachObjectResponse$attachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object that has been attached.</p>",
"BatchAttachToIndexResponse$AttachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>",
"BatchCreateIndexResponse$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>",
"BatchCreateObjectResponse$ObjectIdentifier": "<p>The ID that is associated with the object.</p>",
"BatchDetachFromIndexResponse$DetachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>",
"BatchDetachObjectResponse$detachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the detached object.</p>",
"BatchGetObjectInformationResponse$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the specified object.</p>",
"BatchUpdateObjectAttributesResponse$ObjectIdentifier": "<p>ID that is associated with the object.</p>",
"CreateDirectoryResponse$ObjectIdentifier": "<p>The root object node of the created directory.</p>",
"CreateIndexResponse$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>",
@@ -1399,6 +1627,8 @@
"ObjectIdentifierList": {
"base": null,
"refs": {
"BatchListObjectPoliciesResponse$AttachedPolicyIds": "<p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the object.</p>",
"BatchListPolicyAttachmentsResponse$ObjectIdentifiers": "<p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>",
"ListObjectPoliciesResponse$AttachedPolicyIds": "<p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the object.</p>",
"ListPolicyAttachmentsResponse$ObjectIdentifiers": "<p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>",
"PathToObjectIdentifiers$ObjectIdentifiers": "<p>Lists <code>ObjectIdentifiers</code> starting from directory root to the object in the request.</p>"
@@ -1430,11 +1660,31 @@
"BatchAddFacetToObject$ObjectReference": "<p>A reference to the object being mutated.</p>",
"BatchAttachObject$ParentReference": "<p>The parent object reference.</p>",
"BatchAttachObject$ChildReference": "<p>The child object reference that is to be attached to the object.</p>",
"BatchAttachPolicy$PolicyReference": "<p>The reference that is associated with the policy object.</p>",
"BatchAttachPolicy$ObjectReference": "<p>The reference that identifies the object to which the policy will be attached.</p>",
"BatchAttachToIndex$IndexReference": "<p>A reference to the index that you are attaching the object to.</p>",
"BatchAttachToIndex$TargetReference": "<p>A reference to the object that you are attaching to the index.</p>",
"BatchAttachTypedLink$SourceObjectReference": "<p>Identifies the source object that the typed link will attach to.</p>",
"BatchAttachTypedLink$TargetObjectReference": "<p>Identifies the target object that the typed link will attach to.</p>",
"BatchCreateIndex$ParentReference": "<p>A reference to the parent object that contains the index object.</p>",
"BatchCreateObject$ParentReference": "<p>If specified, the parent reference to which this object will be attached.</p>",
"BatchDeleteObject$ObjectReference": "<p>The reference that identifies the object.</p>",
"BatchDetachFromIndex$IndexReference": "<p>A reference to the index object.</p>",
"BatchDetachFromIndex$TargetReference": "<p>A reference to the object being detached from the index.</p>",
"BatchDetachObject$ParentReference": "<p>Parent reference from which the object with the specified link name is detached.</p>",
"BatchDetachPolicy$PolicyReference": "<p>Reference that identifies the policy object.</p>",
"BatchDetachPolicy$ObjectReference": "<p>Reference that identifies the object whose policy object will be detached.</p>",
"BatchGetObjectInformation$ObjectReference": "<p>A reference to the object.</p>",
"BatchListAttachedIndices$TargetReference": "<p>A reference to the object that has indices attached.</p>",
"BatchListIncomingTypedLinks$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
"BatchListIndex$IndexReference": "<p>The reference to the index to list.</p>",
"BatchListObjectAttributes$ObjectReference": "<p>Reference of the object whose attributes need to be listed.</p>",
"BatchListObjectChildren$ObjectReference": "<p>Reference of the object for which child objects are being listed.</p>",
"BatchListObjectParentPaths$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
"BatchListObjectPolicies$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
"BatchListOutgoingTypedLinks$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
"BatchListPolicyAttachments$PolicyReference": "<p>The reference that identifies the policy object.</p>",
"BatchLookupPolicy$ObjectReference": "<p>Reference that identifies the object whose policies will be looked up.</p>",
"BatchRemoveFacetFromObject$ObjectReference": "<p>A reference to the object whose facet will be removed.</p>",
"BatchUpdateObjectAttributes$ObjectReference": "<p>Reference that identifies the object.</p>",
"CreateIndexRequest$ParentReference": "<p>A reference to the parent object that contains the index object.</p>",
@@ -1446,7 +1696,7 @@
"DetachPolicyRequest$PolicyReference": "<p>Reference that identifies the policy object.</p>",
"DetachPolicyRequest$ObjectReference": "<p>Reference that identifies the object whose policy object will be detached.</p>",
"GetObjectInformationRequest$ObjectReference": "<p>A reference to the object.</p>",
"ListAttachedIndicesRequest$TargetReference": "<p>A reference to the object to that has indices attached.</p>",
"ListAttachedIndicesRequest$TargetReference": "<p>A reference to the object that has indices attached.</p>",
"ListIncomingTypedLinksRequest$ObjectReference": "<p>Reference that identifies the object whose attributes will be listed.</p>",
"ListIndexRequest$IndexReference": "<p>The reference to the index to list.</p>",
"ListObjectAttributesRequest$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
@@ -1487,6 +1737,7 @@
"PathToObjectIdentifiersList": {
"base": null,
"refs": {
"BatchListObjectParentPathsResponse$PathToObjectIdentifiersList": "<p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the directory.</p>",
"ListObjectParentPathsResponse$PathToObjectIdentifiersList": "<p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the directory.</p>"
}
},
@@ -1511,6 +1762,7 @@
"PolicyToPathList": {
"base": null,
"refs": {
"BatchLookupPolicyResponse$PolicyToPathList": "<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>",
"LookupPolicyResponse$PolicyToPathList": "<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
}
},
@@ -1643,6 +1895,7 @@
"base": null,
"refs": {
"BatchCreateObject$SchemaFacet": "<p>A list of <code>FacetArns</code> that will be associated with the object. For more information, see <a>arns</a>.</p>",
"BatchGetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object.</p>",
"CreateObjectRequest$SchemaFacets": "<p>A list of schema facets to be associated with the object that contains <code>SchemaArn</code> and facet name. For more information, see <a>arns</a>.</p>",
"GetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object.</p>"
}
@@ -1770,6 +2023,8 @@
"TypedLinkAttributeRangeList": {
"base": null,
"refs": {
"BatchListIncomingTypedLinks$FilterAttributeRanges": "<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>",
"BatchListOutgoingTypedLinks$FilterAttributeRanges": "<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>",
"ListIncomingTypedLinksRequest$FilterAttributeRanges": "<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>",
"ListOutgoingTypedLinksRequest$FilterAttributeRanges": "<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>"
}
@@ -1814,6 +2069,9 @@
"base": "<p>Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.</p>",
"refs": {
"AttachTypedLinkRequest$TypedLinkFacet": "<p>Identifies the typed link facet that is associated with the typed link.</p>",
"BatchAttachTypedLink$TypedLinkFacet": "<p>Identifies the typed link facet that is associated with the typed link.</p>",
"BatchListIncomingTypedLinks$FilterTypedLink": "<p>Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.</p>",
"BatchListOutgoingTypedLinks$FilterTypedLink": "<p>Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.</p>",
"ListIncomingTypedLinksRequest$FilterTypedLink": "<p>Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.</p>",
"ListOutgoingTypedLinksRequest$FilterTypedLink": "<p>Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.</p>",
"TypedLinkSpecifier$TypedLinkFacet": "<p>Identifies the typed link facet that is associated with the typed link.</p>"
@@ -1823,6 +2081,8 @@
"base": "<p>Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The <a>AttachTypedLink</a> API returns a typed link specifier while the <a>DetachTypedLink</a> API accepts one as input. Similarly, the <a>ListIncomingTypedLinks</a> and <a>ListOutgoingTypedLinks</a> API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.</p>",
"refs": {
"AttachTypedLinkResponse$TypedLinkSpecifier": "<p>Returns a typed link specifier as output.</p>",
"BatchAttachTypedLinkResponse$TypedLinkSpecifier": "<p>Returns a typed link specifier as output.</p>",
"BatchDetachTypedLink$TypedLinkSpecifier": "<p>Used to accept a typed link specifier as input.</p>",
"DetachTypedLinkRequest$TypedLinkSpecifier": "<p>Used to accept a typed link specifier as input.</p>",
"TypedLinkSpecifierList$member": null
}
@@ -1830,6 +2090,8 @@
"TypedLinkSpecifierList": {
"base": null,
"refs": {
"BatchListIncomingTypedLinksResponse$LinkSpecifiers": "<p>Returns one or more typed link specifiers as output.</p>",
"BatchListOutgoingTypedLinksResponse$TypedLinkSpecifiers": "<p>Returns a typed link specifier as output.</p>",
"ListIncomingTypedLinksResponse$LinkSpecifiers": "<p>Returns one or more typed link specifiers as output.</p>",
"ListOutgoingTypedLinksResponse$TypedLinkSpecifiers": "<p>Returns a typed link specifier as output.</p>"
}

885
vendor/github.com/aws/aws-sdk-go/models/apis/cloudformation/2010-05-15/api-2.json generated vendored
View File

File diff suppressed because it is too large Load Diff

603
vendor/github.com/aws/aws-sdk-go/models/apis/cloudformation/2010-05-15/docs-2.json generated vendored
View File

@@ -6,30 +6,73 @@
"ContinueUpdateRollback": "<p>For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p> <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.</p>",
"CreateChangeSet": "<p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.</p> <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action.</p> <p>When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. AWS CloudFormation doesn't make changes until you execute the change set.</p>",
"CreateStack": "<p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API.</p>",
"CreateStackInstances": "<p>Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. <code>Accounts</code> and <code>Regions</code> are required parameters—you must specify at least one account and one region. </p>",
"CreateStackSet": "<p>Creates a stack set.</p>",
"DeleteChangeSet": "<p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p> <p>If the call successfully completes, AWS CloudFormation successfully deleted the change set.</p>",
"DeleteStack": "<p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully.</p>",
"DeleteStackInstances": "<p>Deletes stack instances for the specified accounts, in the specified regions. </p>",
"DeleteStackSet": "<p>Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see <a>DeleteStackInstances</a>. </p>",
"DescribeAccountLimits": "<p>Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.</p>",
"DescribeChangeSet": "<p>Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html\">Updating Stacks Using Change Sets</a> in the AWS CloudFormation User Guide.</p>",
"DescribeStackEvents": "<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html\">Stacks</a> in the AWS CloudFormation User Guide.</p> <note> <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</p> </note>",
"DescribeStackInstance": "<p>Returns the stack instance that's associated with the specified stack set, AWS account, and region.</p> <p>For a list of stack instances that are associated with a specific stack set, use <a>ListStackInstances</a>.</p>",
"DescribeStackResource": "<p>Returns a description of the specified resource in the specified stack.</p> <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</p>",
"DescribeStackResources": "<p>Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned.</p> <note> <p>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</p> </note> <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted.</p> <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/\">AWS CloudFormation User Guide</a>.</p> <note> <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</p> </note>",
"DescribeStackSet": "<p>Returns the description of the specified stack set. </p>",
"DescribeStackSetOperation": "<p>Returns the description of the specified stack set operation. </p>",
"DescribeStacks": "<p>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</p> <note> <p>If the stack does not exist, an <code>AmazonCloudFormationException</code> is returned.</p> </note>",
"EstimateTemplateCost": "<p>Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.</p>",
"ExecuteChangeSet": "<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update.</p> <p>When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.</p> <p>If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.</p>",
"GetStackPolicy": "<p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.</p>",
"GetTemplate": "<p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p> <p>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.</p> <note> <p> If the template does not exist, a <code>ValidationError</code> is returned. </p> </note>",
"GetTemplateSummary": "<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.</p> <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a running or deleted stack.</p> <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned.</p>",
"GetTemplateSummary": "<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.</p> <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.</p> <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned.</p>",
"ListChangeSets": "<p>Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.</p>",
"ListExports": "<p>Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>",
"ListImports": "<p>Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see <a>ListExports</a>. </p> <p>For more information about importing an exported output value, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p>",
"ListStackInstances": "<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>",
"ListStackResources": "<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</p>",
"ListStackSetOperationResults": "<p>Returns summary information about the results of a stack set operation. </p>",
"ListStackSetOperations": "<p>Returns summary information about operations performed on a stack set. </p>",
"ListStackSets": "<p>Returns summary information about stack sets that are associated with the user.</p>",
"ListStacks": "<p>Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).</p>",
"SetStackPolicy": "<p>Sets a stack policy for a specified stack.</p>",
"SignalResource": "<p>Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.</p>",
"StopStackSetOperation": "<p>Stops an in-progress operation on a stack set and its associated stack instances. </p>",
"UpdateStack": "<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>",
"UpdateStackSet": "<p>Updates the stack set and <i>all</i> associated stack instances.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>",
"UpdateTerminationProtection": "<p>Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html\">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> For <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested stack.</p>",
"ValidateTemplate": "<p>Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.</p>"
},
"shapes": {
"Account": {
"base": null,
"refs": {
"AccountList$member": null,
"DescribeStackInstanceInput$StackInstanceAccount": "<p>The ID of an AWS account that's associated with this stack instance.</p>",
"ListStackInstancesInput$StackInstanceAccount": "<p>The name of the AWS account that you want to list stack instances for.</p>",
"StackInstance$Account": "<p>The name of the AWS account that the stack instance is associated with.</p>",
"StackInstanceSummary$Account": "<p>The name of the AWS account that the stack instance is associated with.</p>",
"StackSetOperationResultSummary$Account": "<p>The name of the AWS account for this operation result.</p>"
}
},
"AccountGateResult": {
"base": "<p>Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.</p> <p>For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to <code>FAILED</code>. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html\">Configuring a target account gate</a>.</p>",
"refs": {
"StackSetOperationResultSummary$AccountGateResult": "<p>The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account</p>"
}
},
"AccountGateStatus": {
"base": null,
"refs": {
"AccountGateResult$Status": "<p>The status of the account gate function.</p> <ul> <li> <p> <code>SUCCEEDED</code>: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region. </p> </li> <li> <p> <code>FAILED</code>: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to <code>FAILED</code>. </p> </li> <li> <p> <code>SKIPPED</code>: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:</p> <ul> <li> <p>An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.</p> </li> <li> <p>The <code>AWSCloudFormationStackSetExecutionRole</code> of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.</p> </li> <li> <p>Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.</p> </li> </ul> </li> </ul>"
}
},
"AccountGateStatusReason": {
"base": null,
"refs": {
"AccountGateResult$StatusReason": "<p>The reason for the account gate status assigned to this account and region for the stack set operation.</p>"
}
},
"AccountLimit": {
"base": "<p>The AccountLimit data type.</p>",
"refs": {
@@ -42,6 +85,13 @@
"DescribeAccountLimitsOutput$AccountLimits": "<p>An account limit structure that contain a list of AWS CloudFormation account limits and their values.</p>"
}
},
"AccountList": {
"base": null,
"refs": {
"CreateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.</p>",
"DeleteStackInstancesInput$Accounts": "<p>The names of the AWS accounts that you want to delete stack instances for.</p>"
}
},
"AllowedValue": {
"base": null,
"refs": {
@@ -55,10 +105,16 @@
}
},
"AlreadyExistsException": {
"base": "<p>Resource with the name requested already exists.</p>",
"base": "<p>The resource with the name requested already exists.</p>",
"refs": {
}
},
"Arn": {
"base": null,
"refs": {
"RollbackTrigger$Arn": "<p>The Amazon Resource Name (ARN) of the rollback trigger.</p>"
}
},
"CancelUpdateStackInput": {
"base": "<p>The input for the <a>CancelUpdateStack</a> action.</p>",
"refs": {
@@ -69,10 +125,13 @@
"refs": {
"CreateChangeSetInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
"CreateStackInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
"CreateStackSetInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: </p> <ul> <li> <p>AWS::IAM::AccessKey</p> </li> <li> <p>AWS::IAM::Group</p> </li> <li> <p>AWS::IAM::InstanceProfile</p> </li> <li> <p>AWS::IAM::Policy</p> </li> <li> <p>AWS::IAM::Role</p> </li> <li> <p>AWS::IAM::User</p> </li> <li> <p>AWS::IAM::UserToGroupAddition</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates.</a> </p>",
"DescribeChangeSetOutput$Capabilities": "<p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.</p>",
"GetTemplateSummaryOutput$Capabilities": "<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
"Stack$Capabilities": "<p>The capabilities allowed in the stack.</p>",
"StackSet$Capabilities": "<p>The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates.</a> </p>",
"UpdateStackInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
"UpdateStackSetInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: </p> <ul> <li> <p>AWS::IAM::AccessKey</p> </li> <li> <p>AWS::IAM::Group</p> </li> <li> <p>AWS::IAM::InstanceProfile</p> </li> <li> <p>AWS::IAM::Policy</p> </li> <li> <p>AWS::IAM::Role</p> </li> <li> <p>AWS::IAM::User</p> </li> <li> <p>AWS::IAM::UserToGroupAddition</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates.</a> </p>",
"ValidateTemplateOutput$Capabilities": "<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
}
},
@@ -193,11 +252,23 @@
"refs": {
"CancelUpdateStackInput$ClientRequestToken": "<p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry <code>CancelUpdateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>",
"ContinueUpdateRollbackInput$ClientRequestToken": "<p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry <code>ContinueUpdateRollback</code> requests to ensure that AWS CloudFormation successfully received them.</p>",
"CreateStackInput$ClientRequestToken": "<p>A unique identifier for this <code>CreateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry <code>CreateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>",
"DeleteStackInput$ClientRequestToken": "<p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry <code>DeleteStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>",
"CreateStackInput$ClientRequestToken": "<p>A unique identifier for this <code>CreateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry <code>CreateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>",
"CreateStackInstancesInput$OperationId": "<p>The unique identifier for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
"CreateStackInstancesOutput$OperationId": "<p>The unique identifier for this stack set operation.</p>",
"CreateStackSetInput$ClientRequestToken": "<p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry <code>CreateStackSet</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p>",
"DeleteStackInput$ClientRequestToken": "<p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry <code>DeleteStack</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>",
"DeleteStackInstancesInput$OperationId": "<p>The unique identifier for this stack set operation. </p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
"DeleteStackInstancesOutput$OperationId": "<p>The unique identifier for this stack set operation.</p>",
"DescribeStackSetOperationInput$OperationId": "<p>The unique ID of the stack set operation. </p>",
"ExecuteChangeSetInput$ClientRequestToken": "<p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that AWS CloudFormation successfully received them.</p>",
"StackEvent$ClientRequestToken": "<p>The token passed to the operation that generated this event.</p> <p>For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p>",
"UpdateStackInput$ClientRequestToken": "<p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry <code>UpdateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
"ListStackSetOperationResultsInput$OperationId": "<p>The ID of the stack set operation.</p>",
"StackEvent$ClientRequestToken": "<p>The token passed to the operation that generated this event.</p> <p>All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>",
"StackSetOperation$OperationId": "<p>The unique ID of a stack set operation.</p>",
"StackSetOperationSummary$OperationId": "<p>The unique ID of the stack set operation.</p>",
"StopStackSetOperationInput$OperationId": "<p>The ID of the stack operation. </p>",
"UpdateStackInput$ClientRequestToken": "<p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry <code>UpdateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>",
"UpdateStackSetInput$OperationId": "<p>The unique ID for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, AWS CloudFormation generates one automatically.</p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
"UpdateStackSetOutput$OperationId": "<p>The unique ID for this stack set operation.</p>"
}
},
"ClientToken": {
@@ -231,11 +302,36 @@
"refs": {
}
},
"CreateStackInstancesInput": {
"base": null,
"refs": {
}
},
"CreateStackInstancesOutput": {
"base": null,
"refs": {
}
},
"CreateStackOutput": {
"base": "<p>The output for a <a>CreateStack</a> action.</p>",
"refs": {
}
},
"CreateStackSetInput": {
"base": null,
"refs": {
}
},
"CreateStackSetOutput": {
"base": null,
"refs": {
}
},
"CreatedButModifiedException": {
"base": "<p>The specified resource exists, but has been changed.</p>",
"refs": {
}
},
"CreationTime": {
"base": null,
"refs": {
@@ -260,9 +356,30 @@
"refs": {
}
},
"DeleteStackInstancesInput": {
"base": null,
"refs": {
}
},
"DeleteStackInstancesOutput": {
"base": null,
"refs": {
}
},
"DeleteStackSetInput": {
"base": null,
"refs": {
}
},
"DeleteStackSetOutput": {
"base": null,
"refs": {
}
},
"DeletionTime": {
"base": null,
"refs": {
"Stack$DeletionTime": "<p>The time the stack was deleted.</p>",
"StackSummary$DeletionTime": "<p>The time the stack was deleted.</p>"
}
},
@@ -296,6 +413,16 @@
"refs": {
}
},
"DescribeStackInstanceInput": {
"base": null,
"refs": {
}
},
"DescribeStackInstanceOutput": {
"base": null,
"refs": {
}
},
"DescribeStackResourceInput": {
"base": "<p>The input for <a>DescribeStackResource</a> action.</p>",
"refs": {
@@ -316,6 +443,26 @@
"refs": {
}
},
"DescribeStackSetInput": {
"base": null,
"refs": {
}
},
"DescribeStackSetOperationInput": {
"base": null,
"refs": {
}
},
"DescribeStackSetOperationOutput": {
"base": null,
"refs": {
}
},
"DescribeStackSetOutput": {
"base": null,
"refs": {
}
},
"DescribeStacksInput": {
"base": "<p>The input for <a>DescribeStacks</a> action.</p>",
"refs": {
@@ -331,6 +478,7 @@
"refs": {
"ChangeSetSummary$Description": "<p>Descriptive information about the change set.</p>",
"CreateChangeSetInput$Description": "<p>A description to help you identify this change set.</p>",
"CreateStackSetInput$Description": "<p>A description of the stack set. You can use the description to identify the stack set's purpose or other important information.</p>",
"DescribeChangeSetOutput$Description": "<p>Information about the change set.</p>",
"GetTemplateSummaryOutput$Description": "<p>The value that is defined in the <code>Description</code> property of the template.</p>",
"Output$Description": "<p>User defined description associated with the output.</p>",
@@ -338,7 +486,10 @@
"Stack$Description": "<p>A user-defined description associated with the stack.</p>",
"StackResource$Description": "<p>User defined description associated with the resource.</p>",
"StackResourceDetail$Description": "<p>User defined description associated with the resource.</p>",
"StackSet$Description": "<p>A description of the stack set that you specify when the stack set is created or updated.</p>",
"StackSetSummary$Description": "<p>A description of the stack set that you specify when the stack set is created or updated.</p>",
"TemplateParameter$Description": "<p>User defined description associated with the parameter.</p>",
"UpdateStackSetInput$Description": "<p>A brief description of updates that you are making.</p>",
"ValidateTemplateOutput$Description": "<p>The description found within the template.</p>"
}
},
@@ -349,6 +500,14 @@
"Stack$DisableRollback": "<p>Boolean to enable or disable rollback on stack creation failures:</p> <ul> <li> <p> <code>true</code>: disable rollback</p> </li> <li> <p> <code>false</code>: enable rollback</p> </li> </ul>"
}
},
"EnableTerminationProtection": {
"base": null,
"refs": {
"CreateStackInput$EnableTerminationProtection": "<p>Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html\">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User Guide</i>. Termination protection is disabled on stacks by default. </p> <p> For <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested stack.</p>",
"Stack$EnableTerminationProtection": "<p>Whether termination protection is enabled for the stack.</p> <p> For <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html\">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"UpdateTerminationProtectionInput$EnableTerminationProtection": "<p>Whether to enable termination protection on the specified stack.</p>"
}
},
"EstimateTemplateCostInput": {
"base": "<p>The input for an <a>EstimateTemplateCost</a> action.</p>",
"refs": {
@@ -398,7 +557,8 @@
"base": null,
"refs": {
"Export$Name": "<p>The name of exported output value. Use this name and the <code>Fn::ImportValue</code> function to import the associated value into other stacks. The name is defined in the <code>Export</code> field in the associated stack's <code>Outputs</code> section.</p>",
"ListImportsInput$ExportName": "<p>The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value. </p>"
"ListImportsInput$ExportName": "<p>The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value. </p>",
"Output$ExportName": "<p>The name of the export associated with the output.</p>"
}
},
"ExportValue": {
@@ -413,6 +573,18 @@
"ListExportsOutput$Exports": "<p>The output for the <a>ListExports</a> action.</p>"
}
},
"FailureToleranceCount": {
"base": null,
"refs": {
"StackSetOperationPreferences$FailureToleranceCount": "<p>The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.</p> <p>Conditional: You must specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code> (but not both).</p>"
}
},
"FailureTolerancePercentage": {
"base": null,
"refs": {
"StackSetOperationPreferences$FailureTolerancePercentage": "<p>The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.</p> <p>When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds <i>down</i> to the next whole number.</p> <p>Conditional: You must specify either <code>FailureToleranceCount</code> or <code>FailureTolerancePercentage</code>, but not both.</p>"
}
},
"GetStackPolicyInput": {
"base": "<p>The input for the <a>GetStackPolicy</a> action.</p>",
"refs": {
@@ -450,12 +622,17 @@
}
},
"InsufficientCapabilitiesException": {
"base": "<p>The template contains resources with capabilities that were not specified in the Capabilities parameter.</p>",
"base": "<p>The template contains resources with capabilities that weren't specified in the Capabilities parameter.</p>",
"refs": {
}
},
"InvalidChangeSetStatusException": {
"base": "<p>The specified change set cannot be used to update the stack. For example, the change set status might be <code>CREATE_IN_PROGRESS</code> or the stack status might be <code>UPDATE_IN_PROGRESS</code>.</p>",
"base": "<p>The specified change set can't be used to update the stack. For example, the change set status might be <code>CREATE_IN_PROGRESS</code>, or the stack status might be <code>UPDATE_IN_PROGRESS</code>.</p>",
"refs": {
}
},
"InvalidOperationException": {
"base": "<p>The specified operation isn't valid.</p>",
"refs": {
}
},
@@ -467,7 +644,7 @@
}
},
"LimitExceededException": {
"base": "<p>Quota for the resource has already been reached.</p>",
"base": "<p>The quota for the resource has already been reached.</p> <p>For information on stack set limitations, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-limitations.html\">Limitations of StackSets</a>.</p>",
"refs": {
}
},
@@ -513,6 +690,16 @@
"refs": {
}
},
"ListStackInstancesInput": {
"base": null,
"refs": {
}
},
"ListStackInstancesOutput": {
"base": null,
"refs": {
}
},
"ListStackResourcesInput": {
"base": "<p>The input for the <a>ListStackResource</a> action.</p>",
"refs": {
@@ -523,6 +710,36 @@
"refs": {
}
},
"ListStackSetOperationResultsInput": {
"base": null,
"refs": {
}
},
"ListStackSetOperationResultsOutput": {
"base": null,
"refs": {
}
},
"ListStackSetOperationsInput": {
"base": null,
"refs": {
}
},
"ListStackSetOperationsOutput": {
"base": null,
"refs": {
}
},
"ListStackSetsInput": {
"base": null,
"refs": {
}
},
"ListStackSetsOutput": {
"base": null,
"refs": {
}
},
"ListStacksInput": {
"base": "<p>The input for <a>ListStacks</a> action.</p>",
"refs": {
@@ -547,6 +764,27 @@
"StackResourceSummary$LogicalResourceId": "<p>The logical name of the resource specified in the template.</p>"
}
},
"MaxConcurrentCount": {
"base": null,
"refs": {
"StackSetOperationPreferences$MaxConcurrentCount": "<p>The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of <code>FailureToleranceCount</code>—<code>MaxConcurrentCount</code> is at most one more than the <code>FailureToleranceCount</code> .</p> <p>Note that this setting lets you specify the <i>maximum</i> for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p> <p>Conditional: You must specify either <code>MaxConcurrentCount</code> or <code>MaxConcurrentPercentage</code>, but not both.</p>"
}
},
"MaxConcurrentPercentage": {
"base": null,
"refs": {
"StackSetOperationPreferences$MaxConcurrentPercentage": "<p>The maximum percentage of accounts in which to perform this operation at one time.</p> <p>When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.</p> <p>Note that this setting lets you specify the <i>maximum</i> for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.</p> <p>Conditional: You must specify either <code>MaxConcurrentCount</code> or <code>MaxConcurrentPercentage</code>, but not both.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"ListStackInstancesInput$MaxResults": "<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>",
"ListStackSetOperationResultsInput$MaxResults": "<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>",
"ListStackSetOperationsInput$MaxResults": "<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>",
"ListStackSetsInput$MaxResults": "<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>"
}
},
"Metadata": {
"base": null,
"refs": {
@@ -554,6 +792,17 @@
"StackResourceDetail$Metadata": "<p>The content of the <code>Metadata</code> attribute declared for the resource. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html\">Metadata Attribute</a> in the AWS CloudFormation User Guide.</p>"
}
},
"MonitoringTimeInMinutes": {
"base": null,
"refs": {
"RollbackConfiguration$MonitoringTimeInMinutes": "<p>The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. If any of the alarms goes to ALERT state during the stack operation or this monitoring period, CloudFormation rolls back the entire stack operation. Then, for update operations, if the monitoring period expires without any alarms going to ALERT state CloudFormation proceeds to dispose of old resources as usual.</p> <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources for update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary.</p> <p>If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.</p>"
}
},
"NameAlreadyExistsException": {
"base": "<p>The specified name is already in use.</p>",
"refs": {
}
},
"NextToken": {
"base": null,
"refs": {
@@ -571,8 +820,16 @@
"ListExportsOutput$NextToken": "<p>If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.</p>",
"ListImportsInput$NextToken": "<p>A string (provided by the <a>ListImports</a> response output) that identifies the next page of stacks that are importing the specified exported output value. </p>",
"ListImportsOutput$NextToken": "<p>A string that identifies the next page of exports. If there is no additional page, this value is null.</p>",
"ListStackInstancesInput$NextToken": "<p>If the previous request didn't return all of the remaining results, the response's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>",
"ListStackInstancesOutput$NextToken": "<p>If the request doesn't return all of the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>",
"ListStackResourcesInput$NextToken": "<p>A string that identifies the next page of stack resources that you want to retrieve.</p>",
"ListStackResourcesOutput$NextToken": "<p>If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.</p>",
"ListStackSetOperationResultsInput$NextToken": "<p>If the previous request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackSetOperationResults</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>",
"ListStackSetOperationResultsOutput$NextToken": "<p>If the request doesn't return all results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListOperationResults</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, <code>NextToken</code> is set to <code>null</code>.</p>",
"ListStackSetOperationsInput$NextToken": "<p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackSetOperations</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>",
"ListStackSetOperationsOutput$NextToken": "<p>If the request doesn't return all results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListOperationResults</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, <code>NextToken</code> is set to <code>null</code>.</p>",
"ListStackSetsInput$NextToken": "<p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListStackSets</code> again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>",
"ListStackSetsOutput$NextToken": "<p>If the request doesn't return all of the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>ListStackInstances</code> again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>",
"ListStacksInput$NextToken": "<p>A string that identifies the next page of stacks that you want to retrieve.</p>",
"ListStacksOutput$NextToken": "<p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.</p>"
}
@@ -606,6 +863,21 @@
"CreateStackInput$OnFailure": "<p>Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either <code>OnFailure</code> or <code>DisableRollback</code>, but not both.</p> <p>Default: <code>ROLLBACK</code> </p>"
}
},
"OperationIdAlreadyExistsException": {
"base": "<p>The specified operation ID already exists.</p>",
"refs": {
}
},
"OperationInProgressException": {
"base": "<p>Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.</p>",
"refs": {
}
},
"OperationNotFoundException": {
"base": "<p>The specified ID refers to an operation that doesn't exist.</p>",
"refs": {
}
},
"Output": {
"base": "<p>The Output data type.</p>",
"refs": {
@@ -681,10 +953,13 @@
"refs": {
"CreateChangeSetInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"CreateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"CreateStackSetInput$Parameters": "<p>The input parameters for the stack set template. </p>",
"DescribeChangeSetOutput$Parameters": "<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"EstimateTemplateCostInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters.</p>",
"Stack$Parameters": "<p>A list of <code>Parameter</code> structures.</p>",
"UpdateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>"
"StackSet$Parameters": "<p>A list of input parameters for a stack set.</p>",
"UpdateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"UpdateStackSetInput$Parameters": "<p>A list of input parameters for the stack set template. </p>"
}
},
"PhysicalResourceId": {
@@ -704,6 +979,33 @@
"ResourceTargetDefinition$Name": "<p>If the <code>Attribute</code> value is <code>Properties</code>, the name of the property. For all other attributes, the value is null.</p>"
}
},
"Reason": {
"base": null,
"refs": {
"StackInstance$StatusReason": "<p>The explanation for the specific status code that is assigned to this stack instance.</p>",
"StackInstanceSummary$StatusReason": "<p>The explanation for the specific status code assigned to this stack instance.</p>",
"StackSetOperationResultSummary$StatusReason": "<p>The reason for the assigned result status.</p>"
}
},
"Region": {
"base": null,
"refs": {
"DescribeStackInstanceInput$StackInstanceRegion": "<p>The name of a region that's associated with this stack instance.</p>",
"ListStackInstancesInput$StackInstanceRegion": "<p>The name of the region where you want to list stack instances. </p>",
"RegionList$member": null,
"StackInstance$Region": "<p>The name of the AWS region that the stack instance is associated with.</p>",
"StackInstanceSummary$Region": "<p>The name of the AWS region that the stack instance is associated with.</p>",
"StackSetOperationResultSummary$Region": "<p>The name of the AWS region for this operation result.</p>"
}
},
"RegionList": {
"base": null,
"refs": {
"CreateStackInstancesInput$Regions": "<p>The names of one or more regions where you want to create stack instances using the specified AWS account(s). </p>",
"DeleteStackInstancesInput$Regions": "<p>The regions where you want to delete stack set instances. </p>",
"StackSetOperationPreferences$RegionOrder": "<p>The order of the regions in where you want to perform the stack operation.</p>"
}
},
"Replacement": {
"base": null,
"refs": {
@@ -812,7 +1114,7 @@
"ResourcesToSkip": {
"base": null,
"refs": {
"ContinueUpdateRollbackInput$ResourcesToSkip": "<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To specify resources in a nested stack, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If the <code>ResourceLogicalID</code> is a stack resource (<code>Type: AWS::CloudFormation::Stack</code>), it must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p>"
"ContinueUpdateRollbackInput$ResourcesToSkip": "<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To skip resources that are part of nested stacks, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p> <note> <p>Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks\">Using ResourcesToSkip to recover a nested stacks hierarchy</a>. </p> </note>"
}
},
"RetainResources": {
@@ -821,6 +1123,18 @@
"DeleteStackInput$RetainResources": "<p>For stacks in the <code>DELETE_FAILED</code> state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.</p> <p>Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.</p>"
}
},
"RetainStacks": {
"base": null,
"refs": {
"DeleteStackInstancesInput$RetainStacks": "<p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options\">Stack set operation options</a>.</p>"
}
},
"RetainStacksNullable": {
"base": null,
"refs": {
"StackSetOperation$RetainStacks": "<p>For stack set operations of action type <code>DELETE</code>, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.</p>"
}
},
"RoleARN": {
"base": null,
"refs": {
@@ -832,6 +1146,28 @@
"UpdateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
}
},
"RollbackConfiguration": {
"base": "<p>Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p> <p>Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For each rollback trigger you create, you specify the Cloudwatch alarm that CloudFormation should monitor. CloudFormation monitors the specified alarms during the stack create or update operation, and for the specified amount of time after all resources have been deployed. If any of the alarms goes to ALERT state during the stack operation or the monitoring period, CloudFormation rolls back the entire stack operation. If the monitoring period expires without any alarms going to ALERT state, CloudFormation proceeds to dispose of old resources as usual.</p> <p>By default, CloudFormation only rolls back stack operations if an alarm goes to ALERT state, not INSUFFICIENT_DATA state. To have CloudFormation roll back the stack operation if an alarm goes to INSUFFICIENT_DATA state as well, edit the CloudWatch alarm to treat missing data as <code>breaching</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html\">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p> <p>AWS CloudFormation does not monitor rollback triggers when it rolls back a stack during an update operation.</p>",
"refs": {
"CreateChangeSetInput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
"CreateStackInput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
"DescribeChangeSetOutput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
"Stack$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
"UpdateStackInput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>"
}
},
"RollbackTrigger": {
"base": "<p>A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALERT state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation. </p>",
"refs": {
"RollbackTriggers$member": null
}
},
"RollbackTriggers": {
"base": null,
"refs": {
"RollbackConfiguration$RollbackTriggers": "<p>The triggers to monitor during stack creation or update actions. </p> <p>By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:</p> <ul> <li> <p>If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.</p> </li> <li> <p>If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.</p> </li> <li> <p>If you specify an empty list, AWS CloudFormation removes all currently specified triggers.</p> </li> </ul> <p>If a specified Cloudwatch alarm is missing, the entire stack operation fails and is rolled back. </p>"
}
},
"Scope": {
"base": null,
"refs": {
@@ -875,11 +1211,48 @@
"DescribeChangeSetOutput$StackId": "<p>The ARN of the stack that is associated with the change set.</p>",
"Export$ExportingStackId": "<p>The stack that contains the exported output name and value.</p>",
"Stack$StackId": "<p>Unique identifier of the stack.</p>",
"Stack$ParentId": "<p>For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">Working with Nested Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"Stack$RootId": "<p>For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">Working with Nested Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"StackEvent$StackId": "<p>The unique ID name of the instance of the stack.</p>",
"StackInstance$StackId": "<p>The ID of the stack instance.</p>",
"StackInstanceSummary$StackId": "<p>The ID of the stack instance.</p>",
"StackResource$StackId": "<p>Unique identifier of the stack.</p>",
"StackResourceDetail$StackId": "<p>Unique identifier of the stack.</p>",
"StackSummary$StackId": "<p>Unique stack identifier.</p>",
"UpdateStackOutput$StackId": "<p>Unique identifier of the stack.</p>"
"StackSummary$ParentId": "<p>For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">Working with Nested Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"StackSummary$RootId": "<p>For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">Working with Nested Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"UpdateStackOutput$StackId": "<p>Unique identifier of the stack.</p>",
"UpdateTerminationProtectionOutput$StackId": "<p>The unique ID of the stack.</p>"
}
},
"StackInstance": {
"base": "<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>",
"refs": {
"DescribeStackInstanceOutput$StackInstance": "<p>The stack instance that matches the specified request parameters.</p>"
}
},
"StackInstanceNotFoundException": {
"base": "<p>The specified stack instance doesn't exist.</p>",
"refs": {
}
},
"StackInstanceStatus": {
"base": null,
"refs": {
"StackInstance$Status": "<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>",
"StackInstanceSummary$Status": "<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>"
}
},
"StackInstanceSummaries": {
"base": null,
"refs": {
"ListStackInstancesOutput$Summaries": "<p>A list of <code>StackInstanceSummary</code> structures that contain information about the specified stack instances.</p>"
}
},
"StackInstanceSummary": {
"base": "<p>The structure that contains summary information about a stack instance.</p>",
"refs": {
"StackInstanceSummaries$member": null
}
},
"StackName": {
@@ -915,9 +1288,10 @@
"DeleteChangeSetInput$StackName": "<p>If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.</p>",
"DescribeChangeSetInput$StackName": "<p>If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.</p>",
"ExecuteChangeSetInput$StackName": "<p>If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.</p>",
"GetTemplateSummaryInput$StackName": "<p>The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
"GetTemplateSummaryInput$StackName": "<p>The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
"ListChangeSetsInput$StackName": "<p>The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.</p>",
"SignalResourceInput$StackName": "<p>The stack name or unique stack ID that includes the resource that you want to signal.</p>"
"SignalResourceInput$StackName": "<p>The stack name or unique stack ID that includes the resource that you want to signal.</p>",
"UpdateTerminationProtectionInput$StackName": "<p>The name or unique ID of the stack for which you want to set termination protection.</p>"
}
},
"StackPolicyBody": {
@@ -979,6 +1353,137 @@
"DescribeStackResourcesOutput$StackResources": "<p>A list of <code>StackResource</code> structures.</p>"
}
},
"StackSet": {
"base": "<p>A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires. </p>",
"refs": {
"DescribeStackSetOutput$StackSet": "<p>The specified stack set.</p>"
}
},
"StackSetId": {
"base": null,
"refs": {
"CreateStackSetOutput$StackSetId": "<p>The ID of the stack set that you're creating.</p>",
"StackInstance$StackSetId": "<p>The name or unique ID of the stack set that the stack instance is associated with.</p>",
"StackInstanceSummary$StackSetId": "<p>The name or unique ID of the stack set that the stack instance is associated with.</p>",
"StackSet$StackSetId": "<p>The ID of the stack set.</p>",
"StackSetOperation$StackSetId": "<p>The ID of the stack set.</p>",
"StackSetSummary$StackSetId": "<p>The ID of the stack set.</p>"
}
},
"StackSetName": {
"base": null,
"refs": {
"CreateStackInstancesInput$StackSetName": "<p>The name or unique ID of the stack set that you want to create stack instances from.</p>",
"CreateStackSetInput$StackSetName": "<p>The name to associate with the stack set. The name must be unique in the region where you create your stack set.</p> <note> <p>A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.</p> </note>",
"DeleteStackInstancesInput$StackSetName": "<p>The name or unique ID of the stack set that you want to delete stack instances for.</p>",
"DeleteStackSetInput$StackSetName": "<p>The name or unique ID of the stack set that you're deleting. You can obtain this value by running <a>ListStackSets</a>.</p>",
"DescribeStackInstanceInput$StackSetName": "<p>The name or the unique stack ID of the stack set that you want to get stack instance information for.</p>",
"DescribeStackSetInput$StackSetName": "<p>The name or unique ID of the stack set whose description you want.</p>",
"DescribeStackSetOperationInput$StackSetName": "<p>The name or the unique stack ID of the stack set for the stack operation.</p>",
"ListStackInstancesInput$StackSetName": "<p>The name or unique ID of the stack set that you want to list stack instances for.</p>",
"ListStackSetOperationResultsInput$StackSetName": "<p>The name or unique ID of the stack set that you want to get operation results for.</p>",
"ListStackSetOperationsInput$StackSetName": "<p>The name or unique ID of the stack set that you want to get operation summaries for.</p>",
"StackSet$StackSetName": "<p>The name that's associated with the stack set.</p>",
"StackSetSummary$StackSetName": "<p>The name of the stack set.</p>",
"StopStackSetOperationInput$StackSetName": "<p>The name or unique ID of the stack set that you want to stop the operation for.</p>",
"UpdateStackSetInput$StackSetName": "<p>The name or unique ID of the stack set that you want to update.</p>"
}
},
"StackSetNameOrId": {
"base": null,
"refs": {
"GetTemplateSummaryInput$StackSetName": "<p>The name or unique ID of the stack set from which the stack was created.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>"
}
},
"StackSetNotEmptyException": {
"base": "<p>You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.</p>",
"refs": {
}
},
"StackSetNotFoundException": {
"base": "<p>The specified stack set doesn't exist.</p>",
"refs": {
}
},
"StackSetOperation": {
"base": "<p>The structure that contains information about a stack set operation. </p>",
"refs": {
"DescribeStackSetOperationOutput$StackSetOperation": "<p>The specified stack set operation.</p>"
}
},
"StackSetOperationAction": {
"base": null,
"refs": {
"StackSetOperation$Action": "<p>The type of stack set operation: <code>CREATE</code>, <code>UPDATE</code>, or <code>DELETE</code>. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as <i>all</i> associated stack set instances.</p>",
"StackSetOperationSummary$Action": "<p>The type of operation: <code>CREATE</code>, <code>UPDATE</code>, or <code>DELETE</code>. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as <i>all</i> associated stack set instances.</p>"
}
},
"StackSetOperationPreferences": {
"base": "<p>The user-specified preferences for how AWS CloudFormation performs a stack set operation. </p> <p>For more information on maximum concurrent accounts and failure tolerance, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options\">Stack set operation options</a>.</p>",
"refs": {
"CreateStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
"DeleteStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
"StackSetOperation$OperationPreferences": "<p>The preferences for how AWS CloudFormation performs this stack set operation.</p>",
"UpdateStackSetInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>"
}
},
"StackSetOperationResultStatus": {
"base": null,
"refs": {
"StackSetOperationResultSummary$Status": "<p>The result status of the stack set operation for the given account in the given region.</p> <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. </p> <p>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>RUNNING</code>: The operation in the specified account and region is currently in progress.</p> </li> <li> <p> <code>PENDING</code>: The operation in the specified account and region has yet to start. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation in the specified account and region completed successfully.</p> </li> </ul>"
}
},
"StackSetOperationResultSummaries": {
"base": null,
"refs": {
"ListStackSetOperationResultsOutput$Summaries": "<p>A list of <code>StackSetOperationResultSummary</code> structures that contain information about the specified operation results, for accounts and regions that are included in the operation.</p>"
}
},
"StackSetOperationResultSummary": {
"base": "<p>The structure that contains information about a specified operation's results for a given account in a given region.</p>",
"refs": {
"StackSetOperationResultSummaries$member": null
}
},
"StackSetOperationStatus": {
"base": null,
"refs": {
"StackSetOperation$Status": "<p>The status of the operation. </p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>",
"StackSetOperationSummary$Status": "<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining regions.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
}
},
"StackSetOperationSummaries": {
"base": null,
"refs": {
"ListStackSetOperationsOutput$Summaries": "<p>A list of <code>StackSetOperationSummary</code> structures that contain summary information about operations for the specified stack set.</p>"
}
},
"StackSetOperationSummary": {
"base": "<p>The structures that contain summary information about the specified operation.</p>",
"refs": {
"StackSetOperationSummaries$member": null
}
},
"StackSetStatus": {
"base": null,
"refs": {
"ListStackSetsInput$Status": "<p>The status of the stack sets that you want to get summary information about.</p>",
"StackSet$Status": "<p>The status of the stack set.</p>",
"StackSetSummary$Status": "<p>The status of the stack set.</p>"
}
},
"StackSetSummaries": {
"base": null,
"refs": {
"ListStackSetsOutput$Summaries": "<p>A list of <code>StackSetSummary</code> structures that contain information about the user's stack sets.</p>"
}
},
"StackSetSummary": {
"base": "<p>The structures that contain summary information about the specified stack set.</p>",
"refs": {
"StackSetSummaries$member": null
}
},
"StackStatus": {
"base": null,
"refs": {
@@ -1024,6 +1529,21 @@
"GetTemplateOutput$StagesAvailable": "<p>The stage of the template that you can retrieve. For stacks, the <code>Original</code> and <code>Processed</code> templates are always available. For change sets, the <code>Original</code> template is always available. After AWS CloudFormation finishes creating the change set, the <code>Processed</code> template becomes available.</p>"
}
},
"StaleRequestException": {
"base": "<p>Another operation has been performed on this stack set since the specified operation was performed. </p>",
"refs": {
}
},
"StopStackSetOperationInput": {
"base": null,
"refs": {
}
},
"StopStackSetOperationOutput": {
"base": null,
"refs": {
}
},
"Tag": {
"base": "<p>The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.</p>",
"refs": {
@@ -1045,11 +1565,14 @@
"Tags": {
"base": null,
"refs": {
"CreateChangeSetInput$Tags": "<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.</p>",
"CreateStackInput$Tags": "<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.</p>",
"CreateChangeSetInput$Tags": "<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.</p>",
"CreateStackInput$Tags": "<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.</p>",
"CreateStackSetInput$Tags": "<p>The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.</p> <p>If you specify tags as part of a <code>CreateStackSet</code> action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire <code>CreateStackSet</code> action fails with an <code>access denied</code> error, and the stack set is not created.</p>",
"DescribeChangeSetOutput$Tags": "<p>If you execute the change set, the tags that will be associated with the stack.</p>",
"Stack$Tags": "<p>A list of <code>Tag</code>s that specify information about the stack.</p>",
"UpdateStackInput$Tags": "<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.</p> <p>If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.</p>"
"StackSet$Tags": "<p>A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.</p>",
"UpdateStackInput$Tags": "<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.</p> <p>If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.</p>",
"UpdateStackSetInput$Tags": "<p>The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.</p> <p>If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:</p> <ul> <li> <p>If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. </p> </li> <li> <p>If you specify <i>any</i> tags using this parameter, you must specify <i>all</i> the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well. </p> </li> <li> <p>If you specify an empty value, AWS CloudFormation removes all currently associated tags.</p> </li> </ul> <p>If you specify new tags as part of an <code>UpdateStackSet</code> action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire <code>UpdateStackSet</code> action fails with an <code>access denied</code> error, and the stack set is not updated.</p>"
}
},
"TemplateBody": {
@@ -1057,10 +1580,13 @@
"refs": {
"CreateChangeSetInput$TemplateBody": "<p>A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>",
"CreateStackInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>",
"CreateStackSetInput$TemplateBody": "<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>",
"EstimateTemplateCostInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</p>",
"GetTemplateOutput$TemplateBody": "<p>Structure containing the template body. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>AWS CloudFormation returns the same template that was used when the stack was created.</p>",
"GetTemplateSummaryInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
"GetTemplateSummaryInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
"StackSet$TemplateBody": "<p>The structure that contains the body of the template that was used to create or update the stack set.</p>",
"UpdateStackInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>",
"UpdateStackSetInput$TemplateBody": "<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>",
"ValidateTemplateInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
}
},
@@ -1094,9 +1620,11 @@
"refs": {
"CreateChangeSetInput$TemplateURL": "<p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>",
"CreateStackInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>",
"CreateStackSetInput$TemplateURL": "<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>",
"EstimateTemplateCostInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>",
"GetTemplateSummaryInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
"GetTemplateSummaryInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
"UpdateStackInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>",
"UpdateStackSetInput$TemplateURL": "<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true. </p>",
"ValidateTemplateInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
}
},
@@ -1113,7 +1641,11 @@
"StackEvent$Timestamp": "<p>Time the status was updated.</p>",
"StackResource$Timestamp": "<p>Time the status was updated.</p>",
"StackResourceDetail$LastUpdatedTimestamp": "<p>Time the status was updated.</p>",
"StackResourceSummary$LastUpdatedTimestamp": "<p>Time the status was updated.</p>"
"StackResourceSummary$LastUpdatedTimestamp": "<p>Time the status was updated.</p>",
"StackSetOperation$CreationTimestamp": "<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.</p>",
"StackSetOperation$EndTimestamp": "<p>The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.</p>",
"StackSetOperationSummary$CreationTimestamp": "<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.</p>",
"StackSetOperationSummary$EndTimestamp": "<p>The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.</p>"
}
},
"TokenAlreadyExistsException": {
@@ -1134,6 +1666,12 @@
"ValidateTemplateOutput$DeclaredTransforms": "<p>A list of the transforms that are declared in the template.</p>"
}
},
"Type": {
"base": null,
"refs": {
"RollbackTrigger$Type": "<p>The resource type of the rollback trigger. Currently, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html\">AWS::CloudWatch::Alarm</a> is the only supported resource type.</p>"
}
},
"UpdateStackInput": {
"base": "<p>The input for an <a>UpdateStack</a> action.</p>",
"refs": {
@@ -1144,6 +1682,26 @@
"refs": {
}
},
"UpdateStackSetInput": {
"base": null,
"refs": {
}
},
"UpdateStackSetOutput": {
"base": null,
"refs": {
}
},
"UpdateTerminationProtectionInput": {
"base": null,
"refs": {
}
},
"UpdateTerminationProtectionOutput": {
"base": null,
"refs": {
}
},
"Url": {
"base": null,
"refs": {
@@ -1154,7 +1712,8 @@
"base": null,
"refs": {
"CreateChangeSetInput$UsePreviousTemplate": "<p>Whether to reuse the template that is associated with the stack to create the change set.</p>",
"UpdateStackInput$UsePreviousTemplate": "<p>Reuse the existing template that is associated with the stack that you are updating.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>"
"UpdateStackInput$UsePreviousTemplate": "<p>Reuse the existing template that is associated with the stack that you are updating.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>",
"UpdateStackSetInput$UsePreviousTemplate": "<p>Use the existing template that's associated with the stack set that you're updating.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true. </p>"
}
},
"UsePreviousValue": {

604
vendor/github.com/aws/aws-sdk-go/models/apis/cloudhsmv2/2017-04-28/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,604 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-04-28",
"endpointPrefix":"cloudhsmv2",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"CloudHSM V2",
"serviceFullName":"AWS CloudHSM V2",
"signatureVersion":"v4",
"signingName":"cloudhsm",
"targetPrefix":"BaldrApiService",
"uid":"cloudhsmv2-2017-04-28"
},
"operations":{
"CreateCluster":{
"name":"CreateCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateClusterRequest"},
"output":{"shape":"CreateClusterResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"CreateHsm":{
"name":"CreateHsm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateHsmRequest"},
"output":{"shape":"CreateHsmResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"DeleteCluster":{
"name":"DeleteCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteClusterRequest"},
"output":{"shape":"DeleteClusterResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"DeleteHsm":{
"name":"DeleteHsm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteHsmRequest"},
"output":{"shape":"DeleteHsmResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"DescribeBackups":{
"name":"DescribeBackups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBackupsRequest"},
"output":{"shape":"DescribeBackupsResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"DescribeClusters":{
"name":"DescribeClusters",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeClustersRequest"},
"output":{"shape":"DescribeClustersResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"InitializeCluster":{
"name":"InitializeCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"InitializeClusterRequest"},
"output":{"shape":"InitializeClusterResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"ListTags":{
"name":"ListTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsRequest"},
"output":{"shape":"ListTagsResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"CloudHsmInternalFailureException"},
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmResourceNotFoundException"},
{"shape":"CloudHsmInvalidRequestException"},
{"shape":"CloudHsmAccessDeniedException"}
]
}
},
"shapes":{
"Backup":{
"type":"structure",
"required":["BackupId"],
"members":{
"BackupId":{"shape":"BackupId"},
"BackupState":{"shape":"BackupState"},
"ClusterId":{"shape":"ClusterId"},
"CreateTimestamp":{"shape":"Timestamp"}
}
},
"BackupId":{
"type":"string",
"pattern":"backup-[2-7a-zA-Z]{11,16}"
},
"BackupPolicy":{
"type":"string",
"enum":["DEFAULT"]
},
"BackupState":{
"type":"string",
"enum":[
"CREATE_IN_PROGRESS",
"READY",
"DELETED"
]
},
"Backups":{
"type":"list",
"member":{"shape":"Backup"}
},
"Cert":{
"type":"string",
"max":5000,
"pattern":"[a-zA-Z0-9+-/=\\s]*"
},
"Certificates":{
"type":"structure",
"members":{
"ClusterCsr":{"shape":"Cert"},
"HsmCertificate":{"shape":"Cert"},
"AwsHardwareCertificate":{"shape":"Cert"},
"ManufacturerHardwareCertificate":{"shape":"Cert"},
"ClusterCertificate":{"shape":"Cert"}
}
},
"CloudHsmAccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"CloudHsmInternalFailureException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true,
"fault":true
},
"CloudHsmInvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"CloudHsmResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"CloudHsmServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"Cluster":{
"type":"structure",
"members":{
"BackupPolicy":{"shape":"BackupPolicy"},
"ClusterId":{"shape":"ClusterId"},
"CreateTimestamp":{"shape":"Timestamp"},
"Hsms":{"shape":"Hsms"},
"HsmType":{"shape":"HsmType"},
"PreCoPassword":{"shape":"PreCoPassword"},
"SecurityGroup":{"shape":"SecurityGroup"},
"SourceBackupId":{"shape":"BackupId"},
"State":{"shape":"ClusterState"},
"StateMessage":{"shape":"StateMessage"},
"SubnetMapping":{"shape":"ExternalSubnetMapping"},
"VpcId":{"shape":"VpcId"},
"Certificates":{"shape":"Certificates"}
}
},
"ClusterId":{
"type":"string",
"pattern":"cluster-[2-7a-zA-Z]{11,16}"
},
"ClusterState":{
"type":"string",
"enum":[
"CREATE_IN_PROGRESS",
"UNINITIALIZED",
"INITIALIZE_IN_PROGRESS",
"INITIALIZED",
"ACTIVE",
"UPDATE_IN_PROGRESS",
"DELETE_IN_PROGRESS",
"DELETED",
"DEGRADED"
]
},
"Clusters":{
"type":"list",
"member":{"shape":"Cluster"}
},
"CreateClusterRequest":{
"type":"structure",
"required":[
"SubnetIds",
"HsmType"
],
"members":{
"SubnetIds":{"shape":"SubnetIds"},
"HsmType":{"shape":"HsmType"},
"SourceBackupId":{"shape":"BackupId"}
}
},
"CreateClusterResponse":{
"type":"structure",
"members":{
"Cluster":{"shape":"Cluster"}
}
},
"CreateHsmRequest":{
"type":"structure",
"required":[
"ClusterId",
"AvailabilityZone"
],
"members":{
"ClusterId":{"shape":"ClusterId"},
"AvailabilityZone":{"shape":"ExternalAz"},
"IpAddress":{"shape":"IpAddress"}
}
},
"CreateHsmResponse":{
"type":"structure",
"members":{
"Hsm":{"shape":"Hsm"}
}
},
"DeleteClusterRequest":{
"type":"structure",
"required":["ClusterId"],
"members":{
"ClusterId":{"shape":"ClusterId"}
}
},
"DeleteClusterResponse":{
"type":"structure",
"members":{
"Cluster":{"shape":"Cluster"}
}
},
"DeleteHsmRequest":{
"type":"structure",
"required":["ClusterId"],
"members":{
"ClusterId":{"shape":"ClusterId"},
"HsmId":{"shape":"HsmId"},
"EniId":{"shape":"EniId"},
"EniIp":{"shape":"IpAddress"}
}
},
"DeleteHsmResponse":{
"type":"structure",
"members":{
"HsmId":{"shape":"HsmId"}
}
},
"DescribeBackupsRequest":{
"type":"structure",
"members":{
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxSize"},
"Filters":{"shape":"Filters"}
}
},
"DescribeBackupsResponse":{
"type":"structure",
"members":{
"Backups":{"shape":"Backups"},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeClustersRequest":{
"type":"structure",
"members":{
"Filters":{"shape":"Filters"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxSize"}
}
},
"DescribeClustersResponse":{
"type":"structure",
"members":{
"Clusters":{"shape":"Clusters"},
"NextToken":{"shape":"NextToken"}
}
},
"EniId":{
"type":"string",
"pattern":"eni-[0-9a-fA-F]{8}"
},
"ExternalAz":{
"type":"string",
"pattern":"[a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-\\d[a-z]"
},
"ExternalSubnetMapping":{
"type":"map",
"key":{"shape":"ExternalAz"},
"value":{"shape":"SubnetId"}
},
"Field":{
"type":"string",
"pattern":"[a-zA-Z0-9_-]+"
},
"Filters":{
"type":"map",
"key":{"shape":"Field"},
"value":{"shape":"Strings"}
},
"Hsm":{
"type":"structure",
"required":["HsmId"],
"members":{
"AvailabilityZone":{"shape":"ExternalAz"},
"ClusterId":{"shape":"ClusterId"},
"SubnetId":{"shape":"SubnetId"},
"EniId":{"shape":"EniId"},
"EniIp":{"shape":"IpAddress"},
"HsmId":{"shape":"HsmId"},
"State":{"shape":"HsmState"},
"StateMessage":{"shape":"String"}
}
},
"HsmId":{
"type":"string",
"pattern":"hsm-[2-7a-zA-Z]{11,16}"
},
"HsmState":{
"type":"string",
"enum":[
"CREATE_IN_PROGRESS",
"ACTIVE",
"DEGRADED",
"DELETE_IN_PROGRESS",
"DELETED"
]
},
"HsmType":{
"type":"string",
"pattern":"(hsm1\\.medium)"
},
"Hsms":{
"type":"list",
"member":{"shape":"Hsm"}
},
"InitializeClusterRequest":{
"type":"structure",
"required":[
"ClusterId",
"SignedCert",
"TrustAnchor"
],
"members":{
"ClusterId":{"shape":"ClusterId"},
"SignedCert":{"shape":"Cert"},
"TrustAnchor":{"shape":"Cert"}
}
},
"InitializeClusterResponse":{
"type":"structure",
"members":{
"State":{"shape":"ClusterState"},
"StateMessage":{"shape":"StateMessage"}
}
},
"IpAddress":{
"type":"string",
"pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"
},
"ListTagsRequest":{
"type":"structure",
"required":["ResourceId"],
"members":{
"ResourceId":{"shape":"ClusterId"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxSize"}
}
},
"ListTagsResponse":{
"type":"structure",
"required":["TagList"],
"members":{
"TagList":{"shape":"TagList"},
"NextToken":{"shape":"NextToken"}
}
},
"MaxSize":{
"type":"integer",
"max":100,
"min":1
},
"NextToken":{
"type":"string",
"max":256,
"pattern":".*"
},
"PreCoPassword":{
"type":"string",
"max":32,
"min":7
},
"SecurityGroup":{
"type":"string",
"pattern":"sg-[0-9a-fA-F]"
},
"StateMessage":{
"type":"string",
"max":300,
"pattern":".*"
},
"String":{"type":"string"},
"Strings":{
"type":"list",
"member":{"shape":"String"}
},
"SubnetId":{
"type":"string",
"pattern":"subnet-[0-9a-fA-F]{8}"
},
"SubnetIds":{
"type":"list",
"member":{"shape":"SubnetId"},
"max":10,
"min":1
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{"shape":"TagKey"},
"Value":{"shape":"TagValue"}
}
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceId",
"TagList"
],
"members":{
"ResourceId":{"shape":"ClusterId"},
"TagList":{"shape":"TagList"}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"Timestamp":{"type":"timestamp"},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceId",
"TagKeyList"
],
"members":{
"ResourceId":{"shape":"ClusterId"},
"TagKeyList":{"shape":"TagKeyList"}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"VpcId":{
"type":"string",
"pattern":"vpc-[0-9a-fA-F]"
},
"errorMessage":{"type":"string"}
}
}

425
vendor/github.com/aws/aws-sdk-go/models/apis/cloudhsmv2/2017-04-28/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,425 @@
{
"version": "2.0",
"service": "<p>For more information about AWS CloudHSM, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a> and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>.</p>",
"operations": {
"CreateCluster": "<p>Creates a new AWS CloudHSM cluster.</p>",
"CreateHsm": "<p>Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.</p>",
"DeleteCluster": "<p>Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use <a>DescribeClusters</a>. To delete an HSM, use <a>DeleteHsm</a>.</p>",
"DeleteHsm": "<p>Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use <a>DescribeClusters</a>.</p>",
"DescribeBackups": "<p>Gets information about backups of AWS CloudHSM clusters.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more backups to get.</p>",
"DescribeClusters": "<p>Gets information about AWS CloudHSM clusters.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>DescribeClusters</code> request to get more clusters. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more clusters to get.</p>",
"InitializeCluster": "<p>Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use <a>DescribeClusters</a>.</p>",
"ListTags": "<p>Gets a list of tags for the specified AWS CloudHSM cluster.</p> <p>This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a <code>NextToken</code> value. Use this value in a subsequent <code>ListTags</code> request to get more tags. When you receive a response with no <code>NextToken</code> (or an empty or null value), that means there are no more tags to get.</p>",
"TagResource": "<p>Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.</p>",
"UntagResource": "<p>Removes the specified tag or tags from the specified AWS CloudHSM cluster.</p>"
},
"shapes": {
"Backup": {
"base": "<p>Contains information about a backup of an AWS CloudHSM cluster.</p>",
"refs": {
"Backups$member": null
}
},
"BackupId": {
"base": null,
"refs": {
"Backup$BackupId": "<p>The identifier (ID) of the backup.</p>",
"Cluster$SourceBackupId": "<p>The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.</p>",
"CreateClusterRequest$SourceBackupId": "<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>"
}
},
"BackupPolicy": {
"base": null,
"refs": {
"Cluster$BackupPolicy": "<p>The cluster's backup policy.</p>"
}
},
"BackupState": {
"base": null,
"refs": {
"Backup$BackupState": "<p>The state of the backup.</p>"
}
},
"Backups": {
"base": null,
"refs": {
"DescribeBackupsResponse$Backups": "<p>A list of backups.</p>"
}
},
"Cert": {
"base": null,
"refs": {
"Certificates$ClusterCsr": "<p>The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is <code>UNINITIALIZED</code>.</p>",
"Certificates$HsmCertificate": "<p>The HSM certificate issued (signed) by the HSM hardware.</p>",
"Certificates$AwsHardwareCertificate": "<p>The HSM hardware certificate issued (signed) by AWS CloudHSM.</p>",
"Certificates$ManufacturerHardwareCertificate": "<p>The HSM hardware certificate issued (signed) by the hardware manufacturer.</p>",
"Certificates$ClusterCertificate": "<p>The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.</p>",
"InitializeClusterRequest$SignedCert": "<p>The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format.</p>",
"InitializeClusterRequest$TrustAnchor": "<p>The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format.</p>"
}
},
"Certificates": {
"base": "<p>Contains one or more certificates or a certificate signing request (CSR).</p>",
"refs": {
"Cluster$Certificates": "<p>Contains one or more certificates or a certificate signing request (CSR).</p>"
}
},
"CloudHsmAccessDeniedException": {
"base": "<p>The request was rejected because the requester does not have permission to perform the requested operation.</p>",
"refs": {
}
},
"CloudHsmInternalFailureException": {
"base": "<p>The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.</p>",
"refs": {
}
},
"CloudHsmInvalidRequestException": {
"base": "<p>The request was rejected because it is not a valid request.</p>",
"refs": {
}
},
"CloudHsmResourceNotFoundException": {
"base": "<p>The request was rejected because it refers to a resource that cannot be found.</p>",
"refs": {
}
},
"CloudHsmServiceException": {
"base": "<p>The request was rejected because an error occurred.</p>",
"refs": {
}
},
"Cluster": {
"base": "<p>Contains information about an AWS CloudHSM cluster.</p>",
"refs": {
"Clusters$member": null,
"CreateClusterResponse$Cluster": "<p>Information about the cluster that was created.</p>",
"DeleteClusterResponse$Cluster": "<p>Information about the cluster that was deleted.</p>"
}
},
"ClusterId": {
"base": null,
"refs": {
"Backup$ClusterId": "<p>The identifier (ID) of the cluster that was backed up.</p>",
"Cluster$ClusterId": "<p>The cluster's identifier (ID).</p>",
"CreateHsmRequest$ClusterId": "<p>The identifier (ID) of the HSM's cluster. To find the cluster ID, use <a>DescribeClusters</a>.</p>",
"DeleteClusterRequest$ClusterId": "<p>The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use <a>DescribeClusters</a>.</p>",
"DeleteHsmRequest$ClusterId": "<p>The identifier (ID) of the cluster that contains the HSM that you are deleting.</p>",
"Hsm$ClusterId": "<p>The identifier (ID) of the cluster that contains the HSM.</p>",
"InitializeClusterRequest$ClusterId": "<p>The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use <a>DescribeClusters</a>.</p>",
"ListTagsRequest$ResourceId": "<p>The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use <a>DescribeClusters</a>.</p>",
"TagResourceRequest$ResourceId": "<p>The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use <a>DescribeClusters</a>.</p>",
"UntagResourceRequest$ResourceId": "<p>The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use <a>DescribeClusters</a>.</p>"
}
},
"ClusterState": {
"base": null,
"refs": {
"Cluster$State": "<p>The cluster's state.</p>",
"InitializeClusterResponse$State": "<p>The cluster's state.</p>"
}
},
"Clusters": {
"base": null,
"refs": {
"DescribeClustersResponse$Clusters": "<p>A list of clusters.</p>"
}
},
"CreateClusterRequest": {
"base": null,
"refs": {
}
},
"CreateClusterResponse": {
"base": null,
"refs": {
}
},
"CreateHsmRequest": {
"base": null,
"refs": {
}
},
"CreateHsmResponse": {
"base": null,
"refs": {
}
},
"DeleteClusterRequest": {
"base": null,
"refs": {
}
},
"DeleteClusterResponse": {
"base": null,
"refs": {
}
},
"DeleteHsmRequest": {
"base": null,
"refs": {
}
},
"DeleteHsmResponse": {
"base": null,
"refs": {
}
},
"DescribeBackupsRequest": {
"base": null,
"refs": {
}
},
"DescribeBackupsResponse": {
"base": null,
"refs": {
}
},
"DescribeClustersRequest": {
"base": null,
"refs": {
}
},
"DescribeClustersResponse": {
"base": null,
"refs": {
}
},
"EniId": {
"base": null,
"refs": {
"DeleteHsmRequest$EniId": "<p>The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.</p>",
"Hsm$EniId": "<p>The identifier (ID) of the HSM's elastic network interface (ENI).</p>"
}
},
"ExternalAz": {
"base": null,
"refs": {
"CreateHsmRequest$AvailabilityZone": "<p>The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use <a>DescribeClusters</a>.</p>",
"ExternalSubnetMapping$key": null,
"Hsm$AvailabilityZone": "<p>The Availability Zone that contains the HSM.</p>"
}
},
"ExternalSubnetMapping": {
"base": null,
"refs": {
"Cluster$SubnetMapping": "<p>A map of the cluster's subnets and their corresponding Availability Zones.</p>"
}
},
"Field": {
"base": null,
"refs": {
"Filters$key": null
}
},
"Filters": {
"base": null,
"refs": {
"DescribeBackupsRequest$Filters": "<p>One or more filters to limit the items returned in the response.</p> <p>Use the <code>backupIds</code> filter to return only the specified backups. Specify backups by their backup identifier (ID).</p> <p>Use the <code>clusterIds</code> filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).</p> <p>Use the <code>states</code> filter to return only backups that match the specified state.</p>",
"DescribeClustersRequest$Filters": "<p>One or more filters to limit the items returned in the response.</p> <p>Use the <code>clusterIds</code> filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).</p> <p>Use the <code>vpcIds</code> filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).</p> <p>Use the <code>states</code> filter to return only clusters that match the specified state.</p>"
}
},
"Hsm": {
"base": "<p>Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.</p>",
"refs": {
"CreateHsmResponse$Hsm": "<p>Information about the HSM that was created.</p>",
"Hsms$member": null
}
},
"HsmId": {
"base": null,
"refs": {
"DeleteHsmRequest$HsmId": "<p>The identifier (ID) of the HSM that you are deleting.</p>",
"DeleteHsmResponse$HsmId": "<p>The identifier (ID) of the HSM that was deleted.</p>",
"Hsm$HsmId": "<p>The HSM's identifier (ID).</p>"
}
},
"HsmState": {
"base": null,
"refs": {
"Hsm$State": "<p>The HSM's state.</p>"
}
},
"HsmType": {
"base": null,
"refs": {
"Cluster$HsmType": "<p>The type of HSM that the cluster contains.</p>",
"CreateClusterRequest$HsmType": "<p>The type of HSM to use in the cluster. Currently the only allowed value is <code>hsm1.medium</code>.</p>"
}
},
"Hsms": {
"base": null,
"refs": {
"Cluster$Hsms": "<p>Contains information about the HSMs in the cluster.</p>"
}
},
"InitializeClusterRequest": {
"base": null,
"refs": {
}
},
"InitializeClusterResponse": {
"base": null,
"refs": {
}
},
"IpAddress": {
"base": null,
"refs": {
"CreateHsmRequest$IpAddress": "<p>The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet.</p>",
"DeleteHsmRequest$EniIp": "<p>The IP address of the elastic network interface (ENI) of the HSM that you are deleting.</p>",
"Hsm$EniIp": "<p>The IP address of the HSM's elastic network interface (ENI).</p>"
}
},
"ListTagsRequest": {
"base": null,
"refs": {
}
},
"ListTagsResponse": {
"base": null,
"refs": {
}
},
"MaxSize": {
"base": null,
"refs": {
"DescribeBackupsRequest$MaxResults": "<p>The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a <code>NextToken</code> value.</p>",
"DescribeClustersRequest$MaxResults": "<p>The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a <code>NextToken</code> value.</p>",
"ListTagsRequest$MaxResults": "<p>The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a <code>NextToken</code> value.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
"DescribeBackupsRequest$NextToken": "<p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more backups.</p>",
"DescribeBackupsResponse$NextToken": "<p>An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent <code>DescribeBackups</code> request to get more backups.</p>",
"DescribeClustersRequest$NextToken": "<p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more clusters.</p>",
"DescribeClustersResponse$NextToken": "<p>An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent <code>DescribeClusters</code> request to get more clusters.</p>",
"ListTagsRequest$NextToken": "<p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more tags.</p>",
"ListTagsResponse$NextToken": "<p>An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent <code>ListTags</code> request to get more tags.</p>"
}
},
"PreCoPassword": {
"base": null,
"refs": {
"Cluster$PreCoPassword": "<p>The default password for the cluster's Pre-Crypto Officer (PRECO) user.</p>"
}
},
"SecurityGroup": {
"base": null,
"refs": {
"Cluster$SecurityGroup": "<p>The identifier (ID) of the cluster's security group.</p>"
}
},
"StateMessage": {
"base": null,
"refs": {
"Cluster$StateMessage": "<p>A description of the cluster's state.</p>",
"InitializeClusterResponse$StateMessage": "<p>A description of the cluster's state.</p>"
}
},
"String": {
"base": null,
"refs": {
"Hsm$StateMessage": "<p>A description of the HSM's state.</p>",
"Strings$member": null
}
},
"Strings": {
"base": null,
"refs": {
"Filters$value": null
}
},
"SubnetId": {
"base": null,
"refs": {
"ExternalSubnetMapping$value": null,
"Hsm$SubnetId": "<p>The subnet that contains the HSM's elastic network interface (ENI).</p>",
"SubnetIds$member": null
}
},
"SubnetIds": {
"base": null,
"refs": {
"CreateClusterRequest$SubnetIds": "<p>The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:</p> <ul> <li> <p>All subnets must be in the same virtual private cloud (VPC).</p> </li> <li> <p>You can specify only one subnet per Availability Zone.</p> </li> </ul>"
}
},
"Tag": {
"base": "<p>Contains a tag. A tag is a key-value pair.</p>",
"refs": {
"TagList$member": null
}
},
"TagKey": {
"base": null,
"refs": {
"Tag$Key": "<p>The key of the tag.</p>",
"TagKeyList$member": null
}
},
"TagKeyList": {
"base": null,
"refs": {
"UntagResourceRequest$TagKeyList": "<p>A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.</p>"
}
},
"TagList": {
"base": null,
"refs": {
"ListTagsResponse$TagList": "<p>A list of tags.</p>",
"TagResourceRequest$TagList": "<p>A list of one or more tags.</p>"
}
},
"TagResourceRequest": {
"base": null,
"refs": {
}
},
"TagResourceResponse": {
"base": null,
"refs": {
}
},
"TagValue": {
"base": null,
"refs": {
"Tag$Value": "<p>The value of the tag.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"Backup$CreateTimestamp": "<p>The date and time when the backup was created.</p>",
"Cluster$CreateTimestamp": "<p>The date and time when the cluster was created.</p>"
}
},
"UntagResourceRequest": {
"base": null,
"refs": {
}
},
"UntagResourceResponse": {
"base": null,
"refs": {
}
},
"VpcId": {
"base": null,
"refs": {
"Cluster$VpcId": "<p>The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.</p>"
}
},
"errorMessage": {
"base": null,
"refs": {
"CloudHsmAccessDeniedException$Message": null,
"CloudHsmInternalFailureException$Message": null,
"CloudHsmInvalidRequestException$Message": null,
"CloudHsmResourceNotFoundException$Message": null,
"CloudHsmServiceException$Message": null
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/cloudhsmv2/2017-04-28/examples-1.json generated vendored Normal file
View File

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

19
vendor/github.com/aws/aws-sdk-go/models/apis/cloudhsmv2/2017-04-28/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,19 @@
{
"pagination": {
"DescribeBackups": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"DescribeClusters": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTags": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

120
vendor/github.com/aws/aws-sdk-go/models/apis/codebuild/2016-10-06/api-2.json generated vendored
View File

@@ -11,6 +11,18 @@
"uid":"codebuild-2016-10-06"
},
"operations":{
"BatchDeleteBuilds":{
"name":"BatchDeleteBuilds",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDeleteBuildsInput"},
"output":{"shape":"BatchDeleteBuildsOutput"},
"errors":[
{"shape":"InvalidInputException"}
]
},
"BatchGetBuilds":{
"name":"BatchGetBuilds",
"http":{
@@ -49,6 +61,21 @@
{"shape":"AccountLimitExceededException"}
]
},
"CreateWebhook":{
"name":"CreateWebhook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateWebhookInput"},
"output":{"shape":"CreateWebhookOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"OAuthProviderException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"}
]
},
"DeleteProject":{
"name":"DeleteProject",
"http":{
@@ -61,6 +88,20 @@
{"shape":"InvalidInputException"}
]
},
"DeleteWebhook":{
"name":"DeleteWebhook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteWebhookInput"},
"output":{"shape":"DeleteWebhookOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OAuthProviderException"}
]
},
"ListBuilds":{
"name":"ListBuilds",
"http":{
@@ -177,6 +218,20 @@
"NO_ARTIFACTS"
]
},
"BatchDeleteBuildsInput":{
"type":"structure",
"required":["ids"],
"members":{
"ids":{"shape":"BuildIds"}
}
},
"BatchDeleteBuildsOutput":{
"type":"structure",
"members":{
"buildsDeleted":{"shape":"BuildIds"},
"buildsNotDeleted":{"shape":"BuildsNotDeleted"}
}
},
"BatchGetBuildsInput":{
"type":"structure",
"required":["ids"],
@@ -241,6 +296,13 @@
"max":100,
"min":1
},
"BuildNotDeleted":{
"type":"structure",
"members":{
"id":{"shape":"NonEmptyString"},
"statusCode":{"shape":"String"}
}
},
"BuildPhase":{
"type":"structure",
"members":{
@@ -275,6 +337,10 @@
"type":"list",
"member":{"shape":"Build"}
},
"BuildsNotDeleted":{
"type":"list",
"member":{"shape":"BuildNotDeleted"}
},
"ComputeType":{
"type":"string",
"enum":[
@@ -309,6 +375,19 @@
"project":{"shape":"Project"}
}
},
"CreateWebhookInput":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{"shape":"ProjectName"}
}
},
"CreateWebhookOutput":{
"type":"structure",
"members":{
"webhook":{"shape":"Webhook"}
}
},
"DeleteProjectInput":{
"type":"structure",
"required":["name"],
@@ -321,6 +400,18 @@
"members":{
}
},
"DeleteWebhookInput":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{"shape":"ProjectName"}
}
},
"DeleteWebhookOutput":{
"type":"structure",
"members":{
}
},
"EnvironmentImage":{
"type":"structure",
"members":{
@@ -366,9 +457,17 @@
],
"members":{
"name":{"shape":"NonEmptyString"},
"value":{"shape":"String"}
"value":{"shape":"String"},
"type":{"shape":"EnvironmentVariableType"}
}
},
"EnvironmentVariableType":{
"type":"string",
"enum":[
"PLAINTEXT",
"PARAMETER_STORE"
]
},
"EnvironmentVariables":{
"type":"list",
"member":{"shape":"EnvironmentVariable"}
@@ -395,6 +494,7 @@
"GOLANG",
"DOCKER",
"ANDROID",
"DOTNET",
"BASE"
]
},
@@ -466,6 +566,12 @@
"type":"string",
"min":1
},
"OAuthProviderException":{
"type":"structure",
"members":{
},
"exception":true
},
"PhaseContext":{
"type":"structure",
"members":{
@@ -499,7 +605,8 @@
"encryptionKey":{"shape":"NonEmptyString"},
"tags":{"shape":"TagList"},
"created":{"shape":"Timestamp"},
"lastModified":{"shape":"Timestamp"}
"lastModified":{"shape":"Timestamp"},
"webhook":{"shape":"Webhook"}
}
},
"ProjectArtifacts":{
@@ -605,7 +712,8 @@
"CODECOMMIT",
"CODEPIPELINE",
"GITHUB",
"S3"
"S3",
"BITBUCKET"
]
},
"StartBuildInput":{
@@ -697,6 +805,12 @@
"min":1,
"pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$"
},
"Webhook":{
"type":"structure",
"members":{
"url":{"shape":"NonEmptyString"}
}
},
"WrapperBoolean":{"type":"boolean"},
"WrapperInt":{"type":"integer"},
"WrapperLong":{"type":"long"}

86
vendor/github.com/aws/aws-sdk-go/models/apis/codebuild/2016-10-06/docs-2.json generated vendored
View File

@@ -1,11 +1,14 @@
{
"version": "2.0",
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apach Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the <i>AWS CodeBuild User Guide</i>.</p> <p>AWS CodeBuild supports these operations:</p> <ul> <li> <p> <code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A <i>build environment</i> represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.</p> </li> <li> <p> <code>CreateProject</code>: Creates a build project.</p> </li> <li> <p> <code>DeleteProject</code>: Deletes a build project.</p> </li> <li> <p> <code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build project.</p> </li> <li> <p> <code>UpdateProject</code>: Changes the settings of an existing build project.</p> </li> <li> <p> <code>BatchGetBuilds</code>: Gets information about one or more builds.</p> </li> <li> <p> <code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single build.</p> </li> <li> <p> <code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p> </li> <li> <p> <code>StartBuild</code>: Starts running a build.</p> </li> <li> <p> <code>StopBuild</code>: Attempts to stop running a build.</p> </li> <li> <p> <code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS CodeBuild.</p> </li> </ul>",
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the <i>AWS CodeBuild User Guide</i>.</p> <p>AWS CodeBuild supports these operations:</p> <ul> <li> <p> <code>BatchDeleteBuilds</code>: Deletes one or more builds.</p> </li> <li> <p> <code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A <i>build environment</i> represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.</p> </li> <li> <p> <code>CreateProject</code>: Creates a build project.</p> </li> <li> <p> <code>CreateWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>DeleteProject</code>: Deletes a build project.</p> </li> <li> <p> <code>DeleteWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build project.</p> </li> <li> <p> <code>UpdateProject</code>: Changes the settings of an existing build project.</p> </li> <li> <p> <code>BatchGetBuilds</code>: Gets information about one or more builds.</p> </li> <li> <p> <code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single build.</p> </li> <li> <p> <code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p> </li> <li> <p> <code>StartBuild</code>: Starts running a build.</p> </li> <li> <p> <code>StopBuild</code>: Attempts to stop running a build.</p> </li> <li> <p> <code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS CodeBuild.</p> </li> </ul>",
"operations": {
"BatchDeleteBuilds": "<p>Deletes one or more builds.</p>",
"BatchGetBuilds": "<p>Gets information about builds.</p>",
"BatchGetProjects": "<p>Gets information about build projects.</p>",
"CreateProject": "<p>Creates a build project.</p>",
"CreateWebhook": "<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.</p> <important> <p>If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 in <a href=\"http://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console\">Change a Build Project’s Settings</a>.</p> </important>",
"DeleteProject": "<p>Deletes a build project.</p>",
"DeleteWebhook": "<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.</p>",
"ListBuilds": "<p>Gets a list of build IDs, with each build ID representing a single build.</p>",
"ListBuildsForProject": "<p>Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p>",
"ListCuratedEnvironmentImages": "<p>Gets information about Docker images that are managed by AWS CodeBuild.</p>",
@@ -38,6 +41,16 @@
"ProjectArtifacts$type": "<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project will have build output generated through AWS CodePipeline.</p> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project will not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project will store build output in Amazon Simple Storage Service (Amazon S3).</p> </li> </ul>"
}
},
"BatchDeleteBuildsInput": {
"base": null,
"refs": {
}
},
"BatchDeleteBuildsOutput": {
"base": null,
"refs": {
}
},
"BatchGetBuildsInput": {
"base": null,
"refs": {
@@ -81,12 +94,20 @@
"BuildIds": {
"base": null,
"refs": {
"BatchDeleteBuildsInput$ids": "<p>The IDs of the builds to delete.</p>",
"BatchDeleteBuildsOutput$buildsDeleted": "<p>The IDs of the builds that were successfully deleted.</p>",
"BatchGetBuildsInput$ids": "<p>The IDs of the builds.</p>",
"BatchGetBuildsOutput$buildsNotFound": "<p>The IDs of builds for which information could not be found.</p>",
"ListBuildsForProjectOutput$ids": "<p>A list of build IDs for the specified build project, with each build ID representing a single build.</p>",
"ListBuildsOutput$ids": "<p>A list of build IDs, with each build ID representing a single build.</p>"
}
},
"BuildNotDeleted": {
"base": "<p>Information about a build that could not be successfully deleted.</p>",
"refs": {
"BuildsNotDeleted$member": null
}
},
"BuildPhase": {
"base": "<p>Information about a stage for a build.</p>",
"refs": {
@@ -111,6 +132,12 @@
"BatchGetBuildsOutput$builds": "<p>Information about the requested builds.</p>"
}
},
"BuildsNotDeleted": {
"base": null,
"refs": {
"BatchDeleteBuildsOutput$buildsNotDeleted": "<p>Information about any builds that could not be successfully deleted.</p>"
}
},
"ComputeType": {
"base": null,
"refs": {
@@ -127,6 +154,16 @@
"refs": {
}
},
"CreateWebhookInput": {
"base": null,
"refs": {
}
},
"CreateWebhookOutput": {
"base": null,
"refs": {
}
},
"DeleteProjectInput": {
"base": null,
"refs": {
@@ -137,6 +174,16 @@
"refs": {
}
},
"DeleteWebhookInput": {
"base": null,
"refs": {
}
},
"DeleteWebhookOutput": {
"base": null,
"refs": {
}
},
"EnvironmentImage": {
"base": "<p>Information about a Docker image that is managed by AWS CodeBuild.</p>",
"refs": {
@@ -185,6 +232,12 @@
"EnvironmentVariables$member": null
}
},
"EnvironmentVariableType": {
"base": null,
"refs": {
"EnvironmentVariable$type": "<p>The type of environment variable. Valid values include:</p> <ul> <li> <p> <code>PARAMETER_STORE</code>: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.</p> </li> <li> <p> <code>PLAINTEXT</code>: An environment variable in plaintext format.</p> </li> </ul>"
}
},
"EnvironmentVariables": {
"base": null,
"refs": {
@@ -263,6 +316,7 @@
"Build$sourceVersion": "<p>Any version identifier for the version of the source code to be built.</p>",
"Build$projectName": "<p>The name of the build project.</p>",
"BuildIds$member": null,
"BuildNotDeleted$id": "<p>The ID of the build that could not be successfully deleted.</p>",
"CreateProjectInput$serviceRole": "<p>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
"CreateProjectInput$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
"DeleteProjectInput$name": "<p>The name of the build project.</p>",
@@ -277,7 +331,13 @@
"StopBuildInput$id": "<p>The ID of the build.</p>",
"UpdateProjectInput$name": "<p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>",
"UpdateProjectInput$serviceRole": "<p>The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
"UpdateProjectInput$encryptionKey": "<p>The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>"
"UpdateProjectInput$encryptionKey": "<p>The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
"Webhook$url": "<p>The URL to the webhook.</p>"
}
},
"OAuthProviderException": {
"base": "<p>There was a problem with the underlying OAuth provider.</p>",
"refs": {
}
},
"PhaseContext": {
@@ -336,6 +396,8 @@
"base": null,
"refs": {
"CreateProjectInput$name": "<p>The name of the build project.</p>",
"CreateWebhookInput$projectName": "<p>The name of the build project.</p>",
"DeleteWebhookInput$projectName": "<p>The name of the build project.</p>",
"Project$name": "<p>The name of the build project.</p>"
}
},
@@ -387,9 +449,9 @@
}
},
"SourceAuth": {
"base": "<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>GITHUB</code>).</p>",
"base": "<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>BITBUCKET</code> or <code>GITHUB</code>).</p>",
"refs": {
"ProjectSource$auth": "<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>GITHUB</code>).</p>"
"ProjectSource$auth": "<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>BITBUCKET</code> or <code>GITHUB</code>).</p>"
}
},
"SourceAuthType": {
@@ -401,7 +463,7 @@
"SourceType": {
"base": null,
"refs": {
"ProjectSource$type": "<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <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>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.</p> </li> </ul>"
"ProjectSource$type": "<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>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.</p> </li> </ul>"
}
},
"StartBuildInput": {
@@ -439,6 +501,7 @@
"BuildArtifacts$location": "<p>Information about the location of the build artifacts.</p>",
"BuildArtifacts$sha256sum": "<p>The SHA-256 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
"BuildArtifacts$md5sum": "<p>The MD5 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
"BuildNotDeleted$statusCode": "<p>Additional information about the build that could not be successfully deleted.</p>",
"EnvironmentImage$name": "<p>The name of the Docker image.</p>",
"EnvironmentImage$description": "<p>The description of the Docker image.</p>",
"EnvironmentVariable$value": "<p>The value of the environment variable.</p> <important> <p>We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).</p> </important>",
@@ -456,10 +519,10 @@
"ProjectArtifacts$location": "<p>Information about the build output artifact location, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>",
"ProjectArtifacts$path": "<p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, then <code>path</code> will not be used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>",
"ProjectArtifacts$name": "<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>.</p>",
"ProjectSource$location": "<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page that displays, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to. Then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>",
"ProjectSource$location": "<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page that displays, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to. Then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your Bitbucket account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page that displays, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>",
"ProjectSource$buildspec": "<p>The build spec declaration to use for the builds in this build project.</p> <p>If this value is not specified, a build spec must be included along with the source code to be built.</p>",
"SourceAuth$resource": "<p>The resource value that applies to the specified authorization type.</p>",
"StartBuildInput$sourceVersion": "<p>A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:</p> <ul> <li> <p>For AWS CodeCommit or GitHub: the commit ID to use.</p> </li> <li> <p>For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.</p> </li> </ul>",
"StartBuildInput$sourceVersion": "<p>A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:</p> <ul> <li> <p>For AWS CodeCommit: the commit ID to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.</p> </li> <li> <p>For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.</p> </li> </ul>",
"StartBuildInput$buildspecOverride": "<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>"
}
},
@@ -513,10 +576,17 @@
"Tag$value": "<p>The tag's value.</p>"
}
},
"Webhook": {
"base": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
"refs": {
"CreateWebhookOutput$webhook": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
"Project$webhook": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>"
}
},
"WrapperBoolean": {
"base": null,
"refs": {
"ProjectEnvironment$privilegedMode": "<p>If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=vfs&amp; - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
"ProjectEnvironment$privilegedMode": "<p>If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
}
},
"WrapperInt": {

276
vendor/github.com/aws/aws-sdk-go/models/apis/codebuild/2016-10-06/examples-1.json generated vendored
View File

@@ -1,5 +1,281 @@
{
"version": "1.0",
"examples": {
"BatchGetBuilds": [
{
"input": {
"ids": [
"codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX"
]
},
"output": {
"builds": [
{
"arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"artifacts": {
"location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project"
},
"buildComplete": true,
"buildStatus": "SUCCEEDED",
"currentPhase": "COMPLETED",
"endTime": 1479832474.764,
"environment": {
"type": "LINUX_CONTAINER",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [
],
"image": "aws/codebuild/java:openjdk-8",
"privilegedMode": false
},
"id": "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"initiator": "MyDemoUser",
"logs": {
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=9b0ac37f-d19e-4254-9079-f47e9a389eEX",
"groupName": "/aws/codebuild/codebuild-demo-project",
"streamName": "9b0ac37f-d19e-4254-9079-f47e9a389eEX"
},
"phases": [
{
"durationInSeconds": 0,
"endTime": 1479832342.23,
"phaseStatus": "SUCCEEDED",
"phaseType": "SUBMITTED",
"startTime": 1479832341.854
},
{
"contexts": [
],
"durationInSeconds": 72,
"endTime": 1479832415.064,
"phaseStatus": "SUCCEEDED",
"phaseType": "PROVISIONING",
"startTime": 1479832342.23
},
{
"contexts": [
],
"durationInSeconds": 46,
"endTime": 1479832461.261,
"phaseStatus": "SUCCEEDED",
"phaseType": "DOWNLOAD_SOURCE",
"startTime": 1479832415.064
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832461.354,
"phaseStatus": "SUCCEEDED",
"phaseType": "INSTALL",
"startTime": 1479832461.261
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832461.448,
"phaseStatus": "SUCCEEDED",
"phaseType": "PRE_BUILD",
"startTime": 1479832461.354
},
{
"contexts": [
],
"durationInSeconds": 9,
"endTime": 1479832471.115,
"phaseStatus": "SUCCEEDED",
"phaseType": "BUILD",
"startTime": 1479832461.448
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832471.224,
"phaseStatus": "SUCCEEDED",
"phaseType": "POST_BUILD",
"startTime": 1479832471.115
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479832471.791,
"phaseStatus": "SUCCEEDED",
"phaseType": "UPLOAD_ARTIFACTS",
"startTime": 1479832471.224
},
{
"contexts": [
],
"durationInSeconds": 2,
"endTime": 1479832474.764,
"phaseStatus": "SUCCEEDED",
"phaseType": "FINALIZING",
"startTime": 1479832471.791
},
{
"phaseType": "COMPLETED",
"startTime": 1479832474.764
}
],
"projectName": "codebuild-demo-project",
"source": {
"type": "S3",
"buildspec": "",
"location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip"
},
"startTime": 1479832341.854,
"timeoutInMinutes": 60
},
{
"arn": "arn:aws:codebuild:us-east-1:123456789012:build/codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX",
"artifacts": {
"location": "arn:aws:s3:::codebuild-123456789012-output-bucket/codebuild-demo-project"
},
"buildComplete": true,
"buildStatus": "SUCCEEDED",
"currentPhase": "COMPLETED",
"endTime": 1479401214.239,
"environment": {
"type": "LINUX_CONTAINER",
"computeType": "BUILD_GENERAL1_SMALL",
"environmentVariables": [
],
"image": "aws/codebuild/java:openjdk-8",
"privilegedMode": false
},
"id": "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX",
"initiator": "MyDemoUser",
"logs": {
"deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=b79a46f7-1473-4636-a23f-da9c45c208EX",
"groupName": "/aws/codebuild/codebuild-demo-project",
"streamName": "b79a46f7-1473-4636-a23f-da9c45c208EX"
},
"phases": [
{
"durationInSeconds": 0,
"endTime": 1479401082.342,
"phaseStatus": "SUCCEEDED",
"phaseType": "SUBMITTED",
"startTime": 1479401081.869
},
{
"contexts": [
],
"durationInSeconds": 71,
"endTime": 1479401154.129,
"phaseStatus": "SUCCEEDED",
"phaseType": "PROVISIONING",
"startTime": 1479401082.342
},
{
"contexts": [
],
"durationInSeconds": 45,
"endTime": 1479401199.136,
"phaseStatus": "SUCCEEDED",
"phaseType": "DOWNLOAD_SOURCE",
"startTime": 1479401154.129
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401199.236,
"phaseStatus": "SUCCEEDED",
"phaseType": "INSTALL",
"startTime": 1479401199.136
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401199.345,
"phaseStatus": "SUCCEEDED",
"phaseType": "PRE_BUILD",
"startTime": 1479401199.236
},
{
"contexts": [
],
"durationInSeconds": 9,
"endTime": 1479401208.68,
"phaseStatus": "SUCCEEDED",
"phaseType": "BUILD",
"startTime": 1479401199.345
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401208.783,
"phaseStatus": "SUCCEEDED",
"phaseType": "POST_BUILD",
"startTime": 1479401208.68
},
{
"contexts": [
],
"durationInSeconds": 0,
"endTime": 1479401209.463,
"phaseStatus": "SUCCEEDED",
"phaseType": "UPLOAD_ARTIFACTS",
"startTime": 1479401208.783
},
{
"contexts": [
],
"durationInSeconds": 4,
"endTime": 1479401214.239,
"phaseStatus": "SUCCEEDED",
"phaseType": "FINALIZING",
"startTime": 1479401209.463
},
{
"phaseType": "COMPLETED",
"startTime": 1479401214.239
}
],
"projectName": "codebuild-demo-project",
"source": {
"type": "S3",
"location": "arn:aws:s3:::codebuild-123456789012-input-bucket/MessageUtil.zip"
},
"startTime": 1479401081.869,
"timeoutInMinutes": 60
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets information about builds with the specified build IDs.",
"id": "to-get-information-about-builds-1501187184588",
"title": "To get information about builds"
}
]
}
}

82
vendor/github.com/aws/aws-sdk-go/models/apis/codedeploy/2014-10-06/api-2.json generated vendored
View File

@@ -229,7 +229,10 @@
{"shape":"InvalidAutoRollbackConfigException"},
{"shape":"InvalidLoadBalancerInfoException"},
{"shape":"InvalidDeploymentStyleException"},
{"shape":"InvalidBlueGreenDeploymentConfigurationException"}
{"shape":"InvalidBlueGreenDeploymentConfigurationException"},
{"shape":"InvalidEC2TagCombinationException"},
{"shape":"InvalidOnPremisesTagCombinationException"},
{"shape":"TagSetListLimitExceededException"}
]
},
"DeleteApplication":{
@@ -646,7 +649,10 @@
{"shape":"InvalidAutoRollbackConfigException"},
{"shape":"InvalidLoadBalancerInfoException"},
{"shape":"InvalidDeploymentStyleException"},
{"shape":"InvalidBlueGreenDeploymentConfigurationException"}
{"shape":"InvalidBlueGreenDeploymentConfigurationException"},
{"shape":"InvalidEC2TagCombinationException"},
{"shape":"InvalidOnPremisesTagCombinationException"},
{"shape":"TagSetListLimitExceededException"}
]
}
},
@@ -929,7 +935,10 @@
},
"CreateDeploymentConfigInput":{
"type":"structure",
"required":["deploymentConfigName"],
"required":[
"deploymentConfigName",
"minimumHealthyHosts"
],
"members":{
"deploymentConfigName":{"shape":"DeploymentConfigName"},
"minimumHealthyHosts":{"shape":"MinimumHealthyHosts"}
@@ -961,7 +970,9 @@
"autoRollbackConfiguration":{"shape":"AutoRollbackConfiguration"},
"deploymentStyle":{"shape":"DeploymentStyle"},
"blueGreenDeploymentConfiguration":{"shape":"BlueGreenDeploymentConfiguration"},
"loadBalancerInfo":{"shape":"LoadBalancerInfo"}
"loadBalancerInfo":{"shape":"LoadBalancerInfo"},
"ec2TagSet":{"shape":"EC2TagSet"},
"onPremisesTagSet":{"shape":"OnPremisesTagSet"}
}
},
"CreateDeploymentGroupOutput":{
@@ -1124,7 +1135,9 @@
"blueGreenDeploymentConfiguration":{"shape":"BlueGreenDeploymentConfiguration"},
"loadBalancerInfo":{"shape":"LoadBalancerInfo"},
"lastSuccessfulDeployment":{"shape":"LastDeploymentInfo"},
"lastAttemptedDeployment":{"shape":"LastDeploymentInfo"}
"lastAttemptedDeployment":{"shape":"LastDeploymentInfo"},
"ec2TagSet":{"shape":"EC2TagSet"},
"onPremisesTagSet":{"shape":"OnPremisesTagSet"}
}
},
"DeploymentGroupInfoList":{
@@ -1321,6 +1334,16 @@
"KEY_AND_VALUE"
]
},
"EC2TagSet":{
"type":"structure",
"members":{
"ec2TagSetList":{"shape":"EC2TagSetList"}
}
},
"EC2TagSetList":{
"type":"list",
"member":{"shape":"EC2TagFilterList"}
},
"ELBInfo":{
"type":"structure",
"members":{
@@ -1735,6 +1758,12 @@
},
"exception":true
},
"InvalidEC2TagCombinationException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidEC2TagException":{
"type":"structure",
"members":{
@@ -1801,6 +1830,12 @@
},
"exception":true
},
"InvalidOnPremisesTagCombinationException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidOperationException":{
"type":"structure",
"members":{
@@ -2056,7 +2091,8 @@
"LoadBalancerInfo":{
"type":"structure",
"members":{
"elbInfoList":{"shape":"ELBInfoList"}
"elbInfoList":{"shape":"ELBInfoList"},
"targetGroupInfoList":{"shape":"TargetGroupInfoList"}
}
},
"LogTail":{"type":"string"},
@@ -2084,6 +2120,16 @@
},
"NextToken":{"type":"string"},
"NullableBoolean":{"type":"boolean"},
"OnPremisesTagSet":{
"type":"structure",
"members":{
"onPremisesTagSetList":{"shape":"OnPremisesTagSetList"}
}
},
"OnPremisesTagSetList":{
"type":"list",
"member":{"shape":"TagFilterList"}
},
"RegisterApplicationRevisionInput":{
"type":"structure",
"required":[
@@ -2278,11 +2324,29 @@
},
"exception":true
},
"TagSetListLimitExceededException":{
"type":"structure",
"members":{
},
"exception":true
},
"TargetGroupInfo":{
"type":"structure",
"members":{
"name":{"shape":"TargetGroupName"}
}
},
"TargetGroupInfoList":{
"type":"list",
"member":{"shape":"TargetGroupInfo"}
},
"TargetGroupName":{"type":"string"},
"TargetInstances":{
"type":"structure",
"members":{
"tagFilters":{"shape":"EC2TagFilterList"},
"autoScalingGroups":{"shape":"AutoScalingGroupNameList"}
"autoScalingGroups":{"shape":"AutoScalingGroupNameList"},
"ec2TagSet":{"shape":"EC2TagSet"}
}
},
"TimeRange":{
@@ -2365,7 +2429,9 @@
"autoRollbackConfiguration":{"shape":"AutoRollbackConfiguration"},
"deploymentStyle":{"shape":"DeploymentStyle"},
"blueGreenDeploymentConfiguration":{"shape":"BlueGreenDeploymentConfiguration"},
"loadBalancerInfo":{"shape":"LoadBalancerInfo"}
"loadBalancerInfo":{"shape":"LoadBalancerInfo"},
"ec2TagSet":{"shape":"EC2TagSet"},
"onPremisesTagSet":{"shape":"OnPremisesTagSet"}
}
},
"UpdateDeploymentGroupOutput":{

82
vendor/github.com/aws/aws-sdk-go/models/apis/codedeploy/2014-10-06/docs-2.json generated vendored
View File

@@ -691,9 +691,10 @@
"EC2TagFilterList": {
"base": null,
"refs": {
"CreateDeploymentGroupInput$ec2TagFilters": "<p>The Amazon EC2 tags on which to filter. The deployment group will include EC2 instances with any of the specified tags.</p>",
"DeploymentGroupInfo$ec2TagFilters": "<p>The Amazon EC2 tags on which to filter.</p>",
"TargetInstances$tagFilters": "<p>The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment.</p>",
"CreateDeploymentGroupInput$ec2TagFilters": "<p>The Amazon EC2 tags on which to filter. The deployment group will include EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.</p>",
"DeploymentGroupInfo$ec2TagFilters": "<p>The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.</p>",
"EC2TagSetList$member": null,
"TargetInstances$tagFilters": "<p>The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as ec2TagSet.</p>",
"UpdateDeploymentGroupInput$ec2TagFilters": "<p>The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.</p>"
}
},
@@ -703,8 +704,23 @@
"EC2TagFilter$Type": "<p>The tag filter type:</p> <ul> <li> <p>KEY_ONLY: Key only.</p> </li> <li> <p>VALUE_ONLY: Value only.</p> </li> <li> <p>KEY_AND_VALUE: Key and value.</p> </li> </ul>"
}
},
"EC2TagSet": {
"base": "<p>Information about groups of EC2 instance tags.</p>",
"refs": {
"CreateDeploymentGroupInput$ec2TagSet": "<p>Information about groups of tags applied to EC2 instances. The deployment group will include only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.</p>",
"DeploymentGroupInfo$ec2TagSet": "<p>Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.</p>",
"TargetInstances$ec2TagSet": "<p>Information about the groups of EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters.</p>",
"UpdateDeploymentGroupInput$ec2TagSet": "<p>Information about groups of tags applied to on-premises instances. The deployment group will include only EC2 instances identified by all the tag groups.</p>"
}
},
"EC2TagSetList": {
"base": null,
"refs": {
"EC2TagSet$ec2TagSetList": "<p>A list containing other lists of EC2 instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.</p>"
}
},
"ELBInfo": {
"base": "<p>Information about a load balancer in Elastic Load Balancing to use in a deployment.</p>",
"base": "<p>Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.</p>",
"refs": {
"ELBInfoList$member": null
}
@@ -712,13 +728,13 @@
"ELBInfoList": {
"base": null,
"refs": {
"LoadBalancerInfo$elbInfoList": "<p>An array containing information about the load balancer in Elastic Load Balancing to use in a deployment.</p>"
"LoadBalancerInfo$elbInfoList": "<p>An array containing information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.</p>"
}
},
"ELBName": {
"base": null,
"refs": {
"ELBInfo$name": "<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
"ELBInfo$name": "<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
}
},
"ETag": {
@@ -1106,6 +1122,11 @@
"refs": {
}
},
"InvalidEC2TagCombinationException": {
"base": "<p>A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.</p>",
"refs": {
}
},
"InvalidEC2TagException": {
"base": "<p>The tag was specified in an invalid format.</p>",
"refs": {
@@ -1161,6 +1182,11 @@
"refs": {
}
},
"InvalidOnPremisesTagCombinationException": {
"base": "<p>A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.</p>",
"refs": {
}
},
"InvalidOperationException": {
"base": "<p>An invalid operation was detected.</p>",
"refs": {
@@ -1359,7 +1385,7 @@
}
},
"LoadBalancerInfo": {
"base": "<p>Information about the load balancer used in a deployment.</p>",
"base": "<p>Information about the Elastic Load Balancing load balancer or target group used in a deployment.</p>",
"refs": {
"CreateDeploymentGroupInput$loadBalancerInfo": "<p>Information about the load balancer used in a deployment.</p>",
"DeploymentGroupInfo$loadBalancerInfo": "<p>Information about the load balancer to use in a deployment.</p>",
@@ -1430,6 +1456,20 @@
"StopDeploymentInput$autoRollbackEnabled": "<p>Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.</p>"
}
},
"OnPremisesTagSet": {
"base": "<p>Information about groups of on-premises instance tags.</p>",
"refs": {
"CreateDeploymentGroupInput$onPremisesTagSet": "<p>Information about groups of tags applied to on-premises instances. The deployment group will include only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.</p>",
"DeploymentGroupInfo$onPremisesTagSet": "<p>Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.</p>",
"UpdateDeploymentGroupInput$onPremisesTagSet": "<p>Information about an on-premises instance tag set. The deployment group will include only on-premises instances identified by all the tag groups.</p>"
}
},
"OnPremisesTagSetList": {
"base": null,
"refs": {
"OnPremisesTagSet$onPremisesTagSetList": "<p>A list containing other lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.</p>"
}
},
"RegisterApplicationRevisionInput": {
"base": "<p>Represents the input of a RegisterApplicationRevision operation.</p>",
"refs": {
@@ -1598,9 +1638,10 @@
"TagFilterList": {
"base": null,
"refs": {
"CreateDeploymentGroupInput$onPremisesInstanceTagFilters": "<p>The on-premises instance tags on which to filter. The deployment group will include on-premises instances with any of the specified tags.</p>",
"DeploymentGroupInfo$onPremisesInstanceTagFilters": "<p>The on-premises instance tags on which to filter.</p>",
"CreateDeploymentGroupInput$onPremisesInstanceTagFilters": "<p>The on-premises instance tags on which to filter. The deployment group will include on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.</p>",
"DeploymentGroupInfo$onPremisesInstanceTagFilters": "<p>The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.</p>",
"ListOnPremisesInstancesInput$tagFilters": "<p>The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned.</p>",
"OnPremisesTagSetList$member": null,
"UpdateDeploymentGroupInput$onPremisesInstanceTagFilters": "<p>The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.</p>"
}
},
@@ -1628,6 +1669,29 @@
"refs": {
}
},
"TagSetListLimitExceededException": {
"base": "<p>The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.</p>",
"refs": {
}
},
"TargetGroupInfo": {
"base": "<p>Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.</p>",
"refs": {
"TargetGroupInfoList$member": null
}
},
"TargetGroupInfoList": {
"base": null,
"refs": {
"LoadBalancerInfo$targetGroupInfoList": "<p>An array containing information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.</p>"
}
},
"TargetGroupName": {
"base": null,
"refs": {
"TargetGroupInfo$name": "<p>For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes. </p>"
}
},
"TargetInstances": {
"base": "<p>Information about the instances to be used in the replacement environment in a blue/green deployment.</p>",
"refs": {

27
vendor/github.com/aws/aws-sdk-go/models/apis/codepipeline/2015-07-09/api-2.json generated vendored
View File

@@ -798,7 +798,11 @@
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"ClientToken":{"type":"string"},
"ClientToken":{
"type":"string",
"max":256,
"min":1
},
"Code":{"type":"string"},
"ContinuationToken":{"type":"string"},
"CreateCustomActionTypeInput":{
@@ -1018,7 +1022,8 @@
"GetPipelineOutput":{
"type":"structure",
"members":{
"pipeline":{"shape":"PipelineDeclaration"}
"pipeline":{"shape":"PipelineDeclaration"},
"metadata":{"shape":"PipelineMetadata"}
}
},
"GetPipelineStateInput":{
@@ -1255,7 +1260,11 @@
"max":5,
"min":0
},
"NextToken":{"type":"string"},
"NextToken":{
"type":"string",
"max":2048,
"min":1
},
"Nonce":{"type":"string"},
"NotLatestPipelineExecutionException":{
"type":"structure",
@@ -1279,6 +1288,10 @@
"max":100,
"min":0
},
"PipelineArn":{
"type":"string",
"pattern":"arn:aws(-[\\w]+)*:codepipeline:.+:[0-9]{12}:.+"
},
"PipelineContext":{
"type":"structure",
"members":{
@@ -1349,6 +1362,14 @@
"type":"list",
"member":{"shape":"PipelineSummary"}
},
"PipelineMetadata":{
"type":"structure",
"members":{
"pipelineArn":{"shape":"PipelineArn"},
"created":{"shape":"Timestamp"},
"updated":{"shape":"Timestamp"}
}
},
"PipelineName":{
"type":"string",
"max":100,

122
vendor/github.com/aws/aws-sdk-go/models/apis/codepipeline/2015-07-09/docs-2.json generated vendored
View File

File diff suppressed because one or more lines are too long

123
vendor/github.com/aws/aws-sdk-go/models/apis/codestar/2017-04-19/api-2.json generated vendored
View File

@@ -158,6 +158,20 @@
{"shape":"ValidationException"}
]
},
"ListTagsForProject":{
"name":"ListTagsForProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForProjectRequest"},
"output":{"shape":"ListTagsForProjectResult"},
"errors":[
{"shape":"ProjectNotFoundException"},
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"}
]
},
"ListTeamMembers":{
"name":"ListTeamMembers",
"http":{
@@ -185,6 +199,36 @@
{"shape":"ValidationException"}
]
},
"TagProject":{
"name":"TagProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagProjectRequest"},
"output":{"shape":"TagProjectResult"},
"errors":[
{"shape":"ProjectNotFoundException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ConcurrentModificationException"}
]
},
"UntagProject":{
"name":"UntagProject",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagProjectRequest"},
"output":{"shape":"UntagProjectResult"},
"errors":[
{"shape":"ProjectNotFoundException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ConcurrentModificationException"}
]
},
"UpdateProject":{
"name":"UpdateProject",
"http":{
@@ -414,7 +458,8 @@
"type":"string",
"max":128,
"min":3,
"pattern":"^[\\w-.+]+@[\\w-.+]+$"
"pattern":"^[\\w-.+]+@[\\w-.+]+$",
"sensitive":true
},
"InvalidNextTokenException":{
"type":"structure",
@@ -472,6 +517,25 @@
"nextToken":{"shape":"PaginationToken"}
}
},
"ListTagsForProjectRequest":{
"type":"structure",
"required":["id"],
"members":{
"id":{"shape":"ProjectId"},
"nextToken":{"shape":"PaginationToken"},
"maxResults":{
"shape":"MaxResults",
"box":true
}
}
},
"ListTagsForProjectResult":{
"type":"structure",
"members":{
"tags":{"shape":"Tags"},
"nextToken":{"shape":"PaginationToken"}
}
},
"ListTeamMembersRequest":{
"type":"structure",
"required":["projectId"],
@@ -517,7 +581,7 @@
},
"PaginationToken":{
"type":"string",
"max":256,
"max":512,
"min":1,
"pattern":"^[\\w/+=]+$"
},
@@ -614,6 +678,43 @@
"type":"string",
"pattern":"^arn:aws[^:\\s]*:cloudformation:[^:\\s]+:[0-9]{12}:stack\\/[^:\\s]+\\/[^:\\s]+$"
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagKeys":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagProjectRequest":{
"type":"structure",
"required":[
"id",
"tags"
],
"members":{
"id":{"shape":"ProjectId"},
"tags":{"shape":"Tags"}
}
},
"TagProjectResult":{
"type":"structure",
"members":{
"tags":{"shape":"Tags"}
}
},
"TagValue":{
"type":"string",
"max":256,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"Tags":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"}
},
"TeamMember":{
"type":"structure",
"required":[
@@ -645,6 +746,22 @@
"type":"list",
"member":{"shape":"TeamMember"}
},
"UntagProjectRequest":{
"type":"structure",
"required":[
"id",
"tags"
],
"members":{
"id":{"shape":"ProjectId"},
"tags":{"shape":"TagKeys"}
}
},
"UntagProjectResult":{
"type":"structure",
"members":{
}
},
"UpdateProjectRequest":{
"type":"structure",
"required":["id"],
@@ -712,7 +829,7 @@
"type":"string",
"max":95,
"min":32,
"pattern":"arn:aws:iam::\\d{12}:user\\/[\\w-]+"
"pattern":"^arn:aws:iam::\\d{12}:user(?:(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F))[\\w+=,.@-]+$"
},
"UserProfileAlreadyExistsException":{
"type":"structure",

80
vendor/github.com/aws/aws-sdk-go/models/apis/codestar/2017-04-19/docs-2.json generated vendored
View File

@@ -1,6 +1,6 @@
{
"version": "2.0",
"service": "<fullname>AWS CodeStar</fullname> <p>This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.</p> <p>You can use the AWS CodeStar API to work with:</p> <p>Projects and their resources, by calling the following:</p> <ul> <li> <p> <a>DeleteProject</a>, which deletes a project in AWS CodeStar.</p> </li> <li> <p> <a>DescribeProject</a>, which lists the attributes of a project.</p> </li> <li> <p> <a>ListProjects</a>, which lists all AWS CodeStar projects associated with your AWS account.</p> </li> <li> <p> <a>ListResources</a>, which lists the resources associated with an AWS CodeStar project.</p> </li> <li> <p> <a>UpdateProject</a>, which updates the attributes of an AWS CodeStar project.</p> </li> </ul> <p>Teams and team members, by calling the following:</p> <ul> <li> <p> <a>AssociateTeamMember</a>, which adds an IAM user to the team for an AWS CodeStar project.</p> </li> <li> <p> <a>DisassociateTeamMember</a>, which removes an IAM user from the team for an AWS CodeStar project.</p> </li> <li> <p> <a>ListTeamMembers</a>, which lists all the IAM users in the team for an AWS CodeStar project, including their roles and attributes.</p> </li> </ul> <p>Users, by calling the following:</p> <ul> <li> <p> <a>CreateUserProfile</a>, which creates a user profile that contains data associated with the user across all AWS CodeStar projects.</p> </li> <li> <p> <a>DeleteUserProfile</a>, which deletes all user profile information across all AWS CodeStar projects.</p> </li> <li> <p> <a>DescribeUserProfile</a>, which describes the profile of a user.</p> </li> <li> <p> <a>ListUserProfiles</a>, which lists all AWS CodeStar user profiles.</p> </li> <li> <p> <a>UpdateUserProfile</a>, which updates the profile for an AWS CodeStar user. </p> </li> </ul>",
"service": "<fullname>AWS CodeStar</fullname> <p>This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.</p> <p>You can use the AWS CodeStar API to work with:</p> <p>Projects and their resources, by calling the following:</p> <ul> <li> <p> <code>DeleteProject</code>, which deletes a project.</p> </li> <li> <p> <code>DescribeProject</code>, which lists the attributes of a project.</p> </li> <li> <p> <code>ListProjects</code>, which lists all projects associated with your AWS account.</p> </li> <li> <p> <code>ListResources</code>, which lists the resources associated with a project.</p> </li> <li> <p> <code>ListTagsForProject</code>, which lists the tags associated with a project.</p> </li> <li> <p> <code>TagProject</code>, which adds tags to a project.</p> </li> <li> <p> <code>UntagProject</code>, which removes tags from a project.</p> </li> <li> <p> <code>UpdateProject</code>, which updates the attributes of a project.</p> </li> </ul> <p>Teams and team members, by calling the following:</p> <ul> <li> <p> <code>AssociateTeamMember</code>, which adds an IAM user to the team for a project.</p> </li> <li> <p> <code>DisassociateTeamMember</code>, which removes an IAM user from the team for a project.</p> </li> <li> <p> <code>ListTeamMembers</code>, which lists all the IAM users in the team for a project, including their roles and attributes.</p> </li> <li> <p> <code>UpdateTeamMember</code>, which updates a team member's attributes in a project.</p> </li> </ul> <p>Users, by calling the following:</p> <ul> <li> <p> <code>CreateUserProfile</code>, which creates a user profile that contains data associated with the user across all projects.</p> </li> <li> <p> <code>DeleteUserProfile</code>, which deletes all user profile information across all projects.</p> </li> <li> <p> <code>DescribeUserProfile</code>, which describes the profile of a user.</p> </li> <li> <p> <code>ListUserProfiles</code>, which lists all user profiles.</p> </li> <li> <p> <code>UpdateUserProfile</code>, which updates the profile for a user.</p> </li> </ul>",
"operations": {
"AssociateTeamMember": "<p>Adds an IAM user to the team for an AWS CodeStar project.</p>",
"CreateProject": "<p>Reserved for future use. To create a project, use the AWS CodeStar console.</p>",
@@ -12,8 +12,11 @@
"DisassociateTeamMember": "<p>Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.</p>",
"ListProjects": "<p>Lists all projects in AWS CodeStar associated with your AWS account.</p>",
"ListResources": "<p>Lists resources associated with a project in AWS CodeStar.</p>",
"ListTagsForProject": "<p>Gets the tags for a project.</p>",
"ListTeamMembers": "<p>Lists all team members associated with a project.</p>",
"ListUserProfiles": "<p>Lists all the user profiles configured for your AWS account in AWS CodeStar.</p>",
"TagProject": "<p>Adds tags to a project.</p>",
"UntagProject": "<p>Removes tags from a project.</p>",
"UpdateProject": "<p>Updates a project in AWS CodeStar.</p>",
"UpdateTeamMember": "<p>Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.</p>",
"UpdateUserProfile": "<p>Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. </p>"
@@ -32,8 +35,8 @@
"ClientRequestToken": {
"base": null,
"refs": {
"AssociateTeamMemberRequest$clientRequestToken": "<p>A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request. </p>",
"AssociateTeamMemberResult$clientRequestToken": "<p>The user- or system-generated token from the initial request that can be used to repeat the request. </p>",
"AssociateTeamMemberRequest$clientRequestToken": "<p>A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.</p>",
"AssociateTeamMemberResult$clientRequestToken": "<p>The user- or system-generated token from the initial request that can be used to repeat the request.</p>",
"CreateProjectRequest$clientRequestToken": "<p>Reserved for future use.</p>",
"CreateProjectResult$clientRequestToken": "<p>Reserved for future use.</p>",
"DeleteProjectRequest$clientRequestToken": "<p>A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request. </p>",
@@ -184,6 +187,16 @@
"refs": {
}
},
"ListTagsForProjectRequest": {
"base": null,
"refs": {
}
},
"ListTagsForProjectResult": {
"base": null,
"refs": {
}
},
"ListTeamMembersRequest": {
"base": null,
"refs": {
@@ -208,7 +221,8 @@
"base": null,
"refs": {
"ListProjectsRequest$maxResults": "<p>The maximum amount of data that can be contained in a single set of results.</p>",
"ListResourcesRequest$maxResults": "<p>he maximum amount of data that can be contained in a single set of results.</p>",
"ListResourcesRequest$maxResults": "<p>The maximum amount of data that can be contained in a single set of results.</p>",
"ListTagsForProjectRequest$maxResults": "<p>Reserved for future use.</p>",
"ListTeamMembersRequest$maxResults": "<p>The maximum number of team members you want returned in a response.</p>",
"ListUserProfilesRequest$maxResults": "<p>The maximum number of results to return in a response.</p>"
}
@@ -220,6 +234,8 @@
"ListProjectsResult$nextToken": "<p>The continuation token to use when requesting the next set of results, if there are more results to be returned.</p>",
"ListResourcesRequest$nextToken": "<p>The continuation token for the next set of results, if the results cannot be returned in one response.</p>",
"ListResourcesResult$nextToken": "<p>The continuation token to use when requesting the next set of results, if there are more results to be returned.</p>",
"ListTagsForProjectRequest$nextToken": "<p>Reserved for future use.</p>",
"ListTagsForProjectResult$nextToken": "<p>Reserved for future use.</p>",
"ListTeamMembersRequest$nextToken": "<p>The continuation token for the next set of results, if the results cannot be returned in one response.</p>",
"ListTeamMembersResult$nextToken": "<p>The continuation token to use when requesting the next set of results, if there are more results to be returned.</p>",
"ListUserProfilesRequest$nextToken": "<p>The continuation token for the next set of results, if the results cannot be returned in one response.</p>",
@@ -269,8 +285,11 @@
"DescribeProjectResult$id": "<p>The ID of the project.</p>",
"DisassociateTeamMemberRequest$projectId": "<p>The ID of the AWS CodeStar project from which you want to remove a team member.</p>",
"ListResourcesRequest$projectId": "<p>The ID of the project.</p>",
"ListTagsForProjectRequest$id": "<p>The ID of the project to get tags for.</p>",
"ListTeamMembersRequest$projectId": "<p>The ID of the project for which you want to list team members.</p>",
"ProjectSummary$projectId": "<p>The ID of the project.</p>",
"TagProjectRequest$id": "<p>The ID of the project you want to add a tag to.</p>",
"UntagProjectRequest$id": "<p>The ID of the project to remove tags from.</p>",
"UpdateProjectRequest$id": "<p>The ID of the project you want to update.</p>",
"UpdateTeamMemberRequest$projectId": "<p>The ID of the project.</p>"
}
@@ -338,8 +357,8 @@
"base": null,
"refs": {
"AssociateTeamMemberRequest$projectRole": "<p>The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.</p>",
"TeamMember$projectRole": "<p>The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html\">Working with Teams</a> in the AWS CodeStar User Guide. </p>",
"UpdateTeamMemberRequest$projectRole": "<p>The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html\">Working with Teams</a> in the AWS CodeStar User Guide.</p>",
"TeamMember$projectRole": "<p>The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html\">Working with Teams</a> in the <i>AWS CodeStar User Guide</i>. </p>",
"UpdateTeamMemberRequest$projectRole": "<p>The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html\">Working with Teams</a> in the <i>AWS CodeStar User Guide</i>.</p>",
"UpdateTeamMemberResult$projectRole": "<p>The project role granted to the user.</p>"
}
},
@@ -361,6 +380,43 @@
"DescribeProjectResult$stackId": "<p>The ID of the primary stack in AWS CloudFormation used to generate resources for the project.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
"TagKeys$member": null,
"Tags$key": null
}
},
"TagKeys": {
"base": null,
"refs": {
"UntagProjectRequest$tags": "<p>The tags to remove from the project.</p>"
}
},
"TagProjectRequest": {
"base": null,
"refs": {
}
},
"TagProjectResult": {
"base": null,
"refs": {
}
},
"TagValue": {
"base": null,
"refs": {
"Tags$value": null
}
},
"Tags": {
"base": null,
"refs": {
"ListTagsForProjectResult$tags": "<p>The tags for the project.</p>",
"TagProjectRequest$tags": "<p>The tags you want to add to the project.</p>",
"TagProjectResult$tags": "<p>The tags for the project.</p>"
}
},
"TeamMember": {
"base": "<p>Information about a team member in a project.</p>",
"refs": {
@@ -383,6 +439,16 @@
"ListTeamMembersResult$teamMembers": "<p>A list of team member objects for the project.</p>"
}
},
"UntagProjectRequest": {
"base": null,
"refs": {
}
},
"UntagProjectResult": {
"base": null,
"refs": {
}
},
"UpdateProjectRequest": {
"base": null,
"refs": {
@@ -416,7 +482,7 @@
"UserArn": {
"base": null,
"refs": {
"AssociateTeamMemberRequest$userArn": "<p>The Amazon Resource Name (ARN) for the IAM user you want to add to the DevHub project.</p>",
"AssociateTeamMemberRequest$userArn": "<p>The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.</p>",
"CreateUserProfileRequest$userArn": "<p>The Amazon Resource Name (ARN) of the user in IAM.</p>",
"CreateUserProfileResult$userArn": "<p>The Amazon Resource Name (ARN) of the user in IAM.</p>",
"DeleteUserProfileRequest$userArn": "<p>The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.</p>",

449
vendor/github.com/aws/aws-sdk-go/models/apis/cognito-idp/2016-04-18/api-2.json generated vendored
View File

@@ -126,6 +126,24 @@
{"shape":"InternalErrorException"}
]
},
"AdminDisableProviderForUser":{
"name":"AdminDisableProviderForUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminDisableProviderForUserRequest"},
"output":{"shape":"AdminDisableProviderForUserResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotAuthorizedException"},
{"shape":"UserNotFoundException"},
{"shape":"AliasExistsException"},
{"shape":"InternalErrorException"}
]
},
"AdminDisableUser":{
"name":"AdminDisableUser",
"http":{
@@ -237,6 +255,24 @@
{"shape":"UserNotConfirmedException"}
]
},
"AdminLinkProviderForUser":{
"name":"AdminLinkProviderForUser",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AdminLinkProviderForUserRequest"},
"output":{"shape":"AdminLinkProviderForUserResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotAuthorizedException"},
{"shape":"UserNotFoundException"},
{"shape":"AliasExistsException"},
{"shape":"InternalErrorException"}
]
},
"AdminListDevices":{
"name":"AdminListDevices",
"http":{
@@ -547,6 +583,23 @@
{"shape":"InternalErrorException"}
]
},
"CreateResourceServer":{
"name":"CreateResourceServer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateResourceServerRequest"},
"output":{"shape":"CreateResourceServerResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
]
},
"CreateUserImportJob":{
"name":"CreateUserImportJob",
"http":{
@@ -650,6 +703,21 @@
{"shape":"InternalErrorException"}
]
},
"DeleteResourceServer":{
"name":"DeleteResourceServer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteResourceServerRequest"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
]
},
"DeleteUser":{
"name":"DeleteUser",
"http":{
@@ -751,6 +819,22 @@
{"shape":"InternalErrorException"}
]
},
"DescribeResourceServer":{
"name":"DescribeResourceServer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeResourceServerRequest"},
"output":{"shape":"DescribeResourceServerResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
]
},
"DescribeUserImportJob":{
"name":"DescribeUserImportJob",
"http":{
@@ -929,6 +1013,22 @@
{"shape":"InternalErrorException"}
]
},
"GetUICustomization":{
"name":"GetUICustomization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetUICustomizationRequest"},
"output":{"shape":"GetUICustomizationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
]
},
"GetUser":{
"name":"GetUser",
"http":{
@@ -1070,6 +1170,22 @@
{"shape":"InternalErrorException"}
]
},
"ListResourceServers":{
"name":"ListResourceServers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResourceServersRequest"},
"output":{"shape":"ListResourceServersResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
]
},
"ListUserImportJobs":{
"name":"ListUserImportJobs",
"http":{
@@ -1205,6 +1321,22 @@
{"shape":"InternalErrorException"}
]
},
"SetUICustomization":{
"name":"SetUICustomization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SetUICustomizationRequest"},
"output":{"shape":"SetUICustomizationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
]
},
"SetUserSettings":{
"name":"SetUserSettings",
"http":{
@@ -1337,6 +1469,22 @@
{"shape":"InternalErrorException"}
]
},
"UpdateResourceServer":{
"name":"UpdateResourceServer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateResourceServerRequest"},
"output":{"shape":"UpdateResourceServerResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotAuthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalErrorException"}
]
},
"UpdateUserAttributes":{
"name":"UpdateUserAttributes",
"http":{
@@ -1543,6 +1691,22 @@
"Username":{"shape":"UsernameType"}
}
},
"AdminDisableProviderForUserRequest":{
"type":"structure",
"required":[
"UserPoolId",
"User"
],
"members":{
"UserPoolId":{"shape":"StringType"},
"User":{"shape":"ProviderUserIdentifierType"}
}
},
"AdminDisableProviderForUserResponse":{
"type":"structure",
"members":{
}
},
"AdminDisableUserRequest":{
"type":"structure",
"required":[
@@ -1656,6 +1820,24 @@
"AuthenticationResult":{"shape":"AuthenticationResultType"}
}
},
"AdminLinkProviderForUserRequest":{
"type":"structure",
"required":[
"UserPoolId",
"DestinationUser",
"SourceUser"
],
"members":{
"UserPoolId":{"shape":"StringType"},
"DestinationUser":{"shape":"ProviderUserIdentifierType"},
"SourceUser":{"shape":"ProviderUserIdentifierType"}
}
},
"AdminLinkProviderForUserResponse":{
"type":"structure",
"members":{
}
},
"AdminListDevicesRequest":{
"type":"structure",
"required":[
@@ -1858,9 +2040,14 @@
"type":"list",
"member":{"shape":"AttributeType"}
},
"AttributeMappingKeyType":{
"type":"string",
"max":32,
"min":1
},
"AttributeMappingType":{
"type":"map",
"key":{"shape":"CustomAttributeNameType"},
"key":{"shape":"AttributeMappingKeyType"},
"value":{"shape":"StringType"}
},
"AttributeNameListType":{
@@ -1913,6 +2100,8 @@
}
},
"BooleanType":{"type":"boolean"},
"CSSType":{"type":"string"},
"CSSVersionType":{"type":"string"},
"CallbackURLsListType":{
"type":"list",
"member":{"shape":"RedirectUrlType"},
@@ -2128,7 +2317,7 @@
],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"ProviderName":{"shape":"ProviderNameType"},
"ProviderName":{"shape":"ProviderNameTypeV1"},
"ProviderType":{"shape":"IdentityProviderTypeType"},
"ProviderDetails":{"shape":"ProviderDetailsType"},
"AttributeMapping":{"shape":"AttributeMappingType"},
@@ -2142,6 +2331,27 @@
"IdentityProvider":{"shape":"IdentityProviderType"}
}
},
"CreateResourceServerRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Identifier",
"Name"
],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"Identifier":{"shape":"ResourceServerIdentifierType"},
"Name":{"shape":"ResourceServerNameType"},
"Scopes":{"shape":"ResourceServerScopeListType"}
}
},
"CreateResourceServerResponse":{
"type":"structure",
"required":["ResourceServer"],
"members":{
"ResourceServer":{"shape":"ResourceServerType"}
}
},
"CreateUserImportJobRequest":{
"type":"structure",
"required":[
@@ -2219,6 +2429,7 @@
"SmsVerificationMessage":{"shape":"SmsVerificationMessageType"},
"EmailVerificationMessage":{"shape":"EmailVerificationMessageType"},
"EmailVerificationSubject":{"shape":"EmailVerificationSubjectType"},
"VerificationMessageTemplate":{"shape":"VerificationMessageTemplateType"},
"SmsAuthenticationMessage":{"shape":"SmsVerificationMessageType"},
"MfaConfiguration":{"shape":"UserPoolMfaType"},
"DeviceConfiguration":{"shape":"DeviceConfigurationType"},
@@ -2248,6 +2459,13 @@
"min":1
},
"DateType":{"type":"timestamp"},
"DefaultEmailOptionType":{
"type":"string",
"enum":[
"CONFIRM_WITH_LINK",
"CONFIRM_WITH_CODE"
]
},
"DeleteGroupRequest":{
"type":"structure",
"required":[
@@ -2270,6 +2488,17 @@
"ProviderName":{"shape":"ProviderNameType"}
}
},
"DeleteResourceServerRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Identifier"
],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"Identifier":{"shape":"ResourceServerIdentifierType"}
}
},
"DeleteUserAttributesRequest":{
"type":"structure",
"required":[
@@ -2356,6 +2585,24 @@
"IdentityProvider":{"shape":"IdentityProviderType"}
}
},
"DescribeResourceServerRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Identifier"
],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"Identifier":{"shape":"ResourceServerIdentifierType"}
}
},
"DescribeResourceServerResponse":{
"type":"structure",
"required":["ResourceServer"],
"members":{
"ResourceServer":{"shape":"ResourceServerType"}
}
},
"DescribeUserImportJobRequest":{
"type":"structure",
"required":[
@@ -2484,13 +2731,15 @@
"CREATING",
"DELETING",
"UPDATING",
"ACTIVE"
"ACTIVE",
"FAILED"
]
},
"DomainType":{
"type":"string",
"max":1024,
"min":1
"max":63,
"min":1,
"pattern":"^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$"
},
"DomainVersionType":{
"type":"string",
@@ -2515,12 +2764,24 @@
"ReplyToEmailAddress":{"shape":"EmailAddressType"}
}
},
"EmailVerificationMessageByLinkType":{
"type":"string",
"max":20000,
"min":6,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*"
},
"EmailVerificationMessageType":{
"type":"string",
"max":20000,
"min":6,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*"
},
"EmailVerificationSubjectByLinkType":{
"type":"string",
"max":140,
"min":1,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+"
},
"EmailVerificationSubjectType":{
"type":"string",
"max":140,
@@ -2637,6 +2898,21 @@
"IdentityProvider":{"shape":"IdentityProviderType"}
}
},
"GetUICustomizationRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"ClientId":{"shape":"ClientIdType"}
}
},
"GetUICustomizationResponse":{
"type":"structure",
"required":["UICustomization"],
"members":{
"UICustomization":{"shape":"UICustomizationType"}
}
},
"GetUserAttributeVerificationCodeRequest":{
"type":"structure",
"required":[
@@ -2729,7 +3005,12 @@
},
"IdentityProviderTypeType":{
"type":"string",
"enum":["SAML"]
"enum":[
"SAML",
"Facebook",
"Google",
"LoginWithAmazon"
]
},
"IdpIdentifierType":{
"type":"string",
@@ -2743,6 +3024,8 @@
"max":50,
"min":0
},
"ImageFileType":{"type":"blob"},
"ImageUrlType":{"type":"string"},
"InitiateAuthRequest":{
"type":"structure",
"required":[
@@ -2908,6 +3191,28 @@
"max":60,
"min":1
},
"ListResourceServersLimitType":{
"type":"integer",
"max":50,
"min":1
},
"ListResourceServersRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"MaxResults":{"shape":"ListResourceServersLimitType"},
"NextToken":{"shape":"PaginationKeyType"}
}
},
"ListResourceServersResponse":{
"type":"structure",
"required":["ResourceServers"],
"members":{
"ResourceServers":{"shape":"ResourceServersListType"},
"NextToken":{"shape":"PaginationKeyType"}
}
},
"ListUserImportJobsRequest":{
"type":"structure",
"required":[
@@ -3152,6 +3457,20 @@
"min":1,
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
},
"ProviderNameTypeV1":{
"type":"string",
"max":32,
"min":1,
"pattern":"[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+"
},
"ProviderUserIdentifierType":{
"type":"structure",
"members":{
"ProviderName":{"shape":"ProviderNameType"},
"ProviderAttributeName":{"shape":"StringType"},
"ProviderAttributeValue":{"shape":"StringType"}
}
},
"ProvidersListType":{
"type":"list",
"member":{"shape":"ProviderDescription"},
@@ -3204,6 +3523,58 @@
},
"exception":true
},
"ResourceServerIdentifierType":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+"
},
"ResourceServerNameType":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\w\\s+=,.@-]+"
},
"ResourceServerScopeDescriptionType":{
"type":"string",
"max":256,
"min":1
},
"ResourceServerScopeListType":{
"type":"list",
"member":{"shape":"ResourceServerScopeType"},
"max":25
},
"ResourceServerScopeNameType":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\x21\\x23-\\x2E\\x30-\\x5B\\x5D-\\x7E]+"
},
"ResourceServerScopeType":{
"type":"structure",
"required":[
"ScopeName",
"ScopeDescription"
],
"members":{
"ScopeName":{"shape":"ResourceServerScopeNameType"},
"ScopeDescription":{"shape":"ResourceServerScopeDescriptionType"}
}
},
"ResourceServerType":{
"type":"structure",
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"Identifier":{"shape":"ResourceServerIdentifierType"},
"Name":{"shape":"ResourceServerNameType"},
"Scopes":{"shape":"ResourceServerScopeListType"}
}
},
"ResourceServersListType":{
"type":"list",
"member":{"shape":"ResourceServerType"}
},
"RespondToAuthChallengeRequest":{
"type":"structure",
"required":[
@@ -3268,7 +3639,8 @@
},
"ScopeListType":{
"type":"list",
"member":{"shape":"ScopeType"}
"member":{"shape":"ScopeType"},
"max":25
},
"ScopeType":{
"type":"string",
@@ -3297,6 +3669,23 @@
"max":2048,
"min":20
},
"SetUICustomizationRequest":{
"type":"structure",
"required":["UserPoolId"],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"ClientId":{"shape":"ClientIdType"},
"CSS":{"shape":"CSSType"},
"ImageFile":{"shape":"ImageFileType"}
}
},
"SetUICustomizationResponse":{
"type":"structure",
"required":["UICustomization"],
"members":{
"UICustomization":{"shape":"UICustomizationType"}
}
},
"SetUserSettingsRequest":{
"type":"structure",
"required":[
@@ -3427,6 +3816,18 @@
},
"exception":true
},
"UICustomizationType":{
"type":"structure",
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"ClientId":{"shape":"ClientIdType"},
"ImageUrl":{"shape":"ImageUrlType"},
"CSS":{"shape":"CSSType"},
"CSSVersion":{"shape":"CSSVersionType"},
"LastModifiedDate":{"shape":"DateType"},
"CreationDate":{"shape":"DateType"}
}
},
"UnexpectedLambdaException":{
"type":"structure",
"members":{
@@ -3506,6 +3907,27 @@
"IdentityProvider":{"shape":"IdentityProviderType"}
}
},
"UpdateResourceServerRequest":{
"type":"structure",
"required":[
"UserPoolId",
"Identifier",
"Name"
],
"members":{
"UserPoolId":{"shape":"UserPoolIdType"},
"Identifier":{"shape":"ResourceServerIdentifierType"},
"Name":{"shape":"ResourceServerNameType"},
"Scopes":{"shape":"ResourceServerScopeListType"}
}
},
"UpdateResourceServerResponse":{
"type":"structure",
"required":["ResourceServer"],
"members":{
"ResourceServer":{"shape":"ResourceServerType"}
}
},
"UpdateUserAttributesRequest":{
"type":"structure",
"required":[
@@ -3563,6 +3985,7 @@
"SmsVerificationMessage":{"shape":"SmsVerificationMessageType"},
"EmailVerificationMessage":{"shape":"EmailVerificationMessageType"},
"EmailVerificationSubject":{"shape":"EmailVerificationSubjectType"},
"VerificationMessageTemplate":{"shape":"VerificationMessageTemplateType"},
"SmsAuthenticationMessage":{"shape":"SmsVerificationMessageType"},
"MfaConfiguration":{"shape":"UserPoolMfaType"},
"DeviceConfiguration":{"shape":"DeviceConfigurationType"},
@@ -3765,6 +4188,7 @@
"SmsVerificationMessage":{"shape":"SmsVerificationMessageType"},
"EmailVerificationMessage":{"shape":"EmailVerificationMessageType"},
"EmailVerificationSubject":{"shape":"EmailVerificationSubjectType"},
"VerificationMessageTemplate":{"shape":"VerificationMessageTemplateType"},
"SmsAuthenticationMessage":{"shape":"SmsVerificationMessageType"},
"MfaConfiguration":{"shape":"UserPoolMfaType"},
"DeviceConfiguration":{"shape":"DeviceConfigurationType"},
@@ -3830,6 +4254,17 @@
"type":"list",
"member":{"shape":"UserType"}
},
"VerificationMessageTemplateType":{
"type":"structure",
"members":{
"SmsMessage":{"shape":"SmsVerificationMessageType"},
"EmailMessage":{"shape":"EmailVerificationMessageType"},
"EmailSubject":{"shape":"EmailVerificationSubjectType"},
"EmailMessageByLink":{"shape":"EmailVerificationMessageByLinkType"},
"EmailSubjectByLink":{"shape":"EmailVerificationSubjectByLinkType"},
"DefaultEmailOption":{"shape":"DefaultEmailOptionType"}
}
},
"VerifiedAttributeType":{
"type":"string",
"enum":[

287
vendor/github.com/aws/aws-sdk-go/models/apis/cognito-idp/2016-04-18/docs-2.json generated vendored
View File

@@ -8,12 +8,14 @@
"AdminCreateUser": "<p>Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to <a href=\"API_CreateUserPool.html\">CreateUserPool</a> or <a href=\"API_UpdateUserPool.html\">UpdateUserPool</a>. This template includes your custom sign-up instructions and placeholders for user name and temporary password.</p> <p>Requires developer credentials.</p>",
"AdminDeleteUser": "<p>Deletes a user as an administrator. Works on any user.</p> <p>Requires developer credentials.</p>",
"AdminDeleteUserAttributes": "<p>Deletes the user attributes in a user pool as an administrator. Works on any user.</p> <p>Requires developer credentials.</p>",
"AdminDisableProviderForUser": "<p>Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked <code>DestinationUser</code>) signs in, they must create a new user account. See <a href=\"API_AdminLinkProviderForUser.html\">AdminLinkProviderForUser</a>.</p> <p>This action is enabled only for admin access and requires developer credentials.</p> <p>The <code>ProviderName</code> must match the value specified when creating an IdP for the pool. </p> <p>To disable a native username + password user, the <code>ProviderName</code> value must be <code>Cognito</code> and the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code>, with the <code>ProviderAttributeValue</code> being the name that is used in the user pool for the user.</p> <p>The <code>ProviderAttributeName</code> must always be <code>Cognito_Subject</code> for social identity providers. The <code>ProviderAttributeValue</code> must always be the exact subject that was used when the user was originally linked as a source user.</p> <p>For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the <code>ProviderAttributeName</code> and <code>ProviderAttributeValue</code> must be the same values that were used for the <code>SourceUser</code> when the identities were originally linked in the <a href=\"API_AdminLinkProviderForUser.html\">AdminLinkProviderForUser</a> call. (If the linking was done with <code>ProviderAttributeName</code> set to <code>Cognito_Subject</code>, the same applies here). However, if the user has already signed in, the <code>ProviderAttributeName</code> must be <code>Cognito_Subject</code> and <code>ProviderAttributeValue</code> must be the subject of the SAML assertion.</p>",
"AdminDisableUser": "<p>Disables the specified user as an administrator. Works on any user.</p> <p>Requires developer credentials.</p>",
"AdminEnableUser": "<p>Enables the specified user as an administrator. Works on any user.</p> <p>Requires developer credentials.</p>",
"AdminForgetDevice": "<p>Forgets the device, as an administrator.</p> <p>Requires developer credentials.</p>",
"AdminGetDevice": "<p>Gets the device, as an administrator.</p> <p>Requires developer credentials.</p>",
"AdminGetUser": "<p>Gets the specified user by user name in a user pool as an administrator. Works on any user.</p> <p>Requires developer credentials.</p>",
"AdminInitiateAuth": "<p>Initiates the authentication flow, as an administrator.</p> <p>Requires developer credentials.</p>",
"AdminLinkProviderForUser": "<p>Links an existing user account in a user pool (<code>DestinationUser</code>) to an identity from an external identity provider (<code>SourceUser</code>) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account. </p> <p> For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account. </p> <important> <p>Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.</p> </important> <p>See also <a href=\"API_AdminDisableProviderForUser.html\">AdminDisableProviderForUser</a>.</p> <p>This action is enabled only for admin access and requires developer credentials.</p>",
"AdminListDevices": "<p>Lists devices, as an administrator.</p> <p>Requires developer credentials.</p>",
"AdminListGroupsForUser": "<p>Lists the groups that the user belongs to.</p> <p>Requires developer credentials.</p>",
"AdminRemoveUserFromGroup": "<p>Removes the specified user from the specified group.</p> <p>Requires developer credentials.</p>",
@@ -29,18 +31,21 @@
"ConfirmSignUp": "<p>Confirms registration of a user and handles the existing alias from a previous user.</p>",
"CreateGroup": "<p>Creates a new group in the specified user pool.</p> <p>Requires developer credentials.</p>",
"CreateIdentityProvider": "<p>Creates an identity provider for a user pool.</p>",
"CreateResourceServer": "<p>Creates a new OAuth2.0 resource server and defines custom scopes in it.</p>",
"CreateUserImportJob": "<p>Creates the user import job.</p>",
"CreateUserPool": "<p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p>",
"CreateUserPoolClient": "<p>Creates the user pool client.</p>",
"CreateUserPoolDomain": "<p>Creates a new domain for a user pool.</p>",
"DeleteGroup": "<p>Deletes a group. Currently only groups with no members can be deleted.</p> <p>Requires developer credentials.</p>",
"DeleteIdentityProvider": "<p>Deletes an identity provider for a user pool.</p>",
"DeleteUser": "<p>Allows a user to delete one's self.</p>",
"DeleteResourceServer": "<p>Deletes a resource server.</p>",
"DeleteUser": "<p>Allows a user to delete himself or herself.</p>",
"DeleteUserAttributes": "<p>Deletes the attributes for a user.</p>",
"DeleteUserPool": "<p>Deletes the specified Amazon Cognito user pool.</p>",
"DeleteUserPoolClient": "<p>Allows the developer to delete the user pool client.</p>",
"DeleteUserPoolDomain": "<p>Deletes a domain for a user pool.</p>",
"DescribeIdentityProvider": "<p>Gets information about a specific identity provider.</p>",
"DescribeResourceServer": "<p>Describes a resource server.</p>",
"DescribeUserImportJob": "<p>Describes the user import job.</p>",
"DescribeUserPool": "<p>Returns the configuration information and metadata of the specified user pool.</p>",
"DescribeUserPoolClient": "<p>Client method for returning the configuration information and metadata of the specified user pool client.</p>",
@@ -51,6 +56,7 @@
"GetDevice": "<p>Gets the device.</p>",
"GetGroup": "<p>Gets a group.</p> <p>Requires developer credentials.</p>",
"GetIdentityProviderByIdentifier": "<p>Gets the specified identity provider.</p>",
"GetUICustomization": "<p>Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app <code>clientId</code> will be <code>ALL</code>), then that is returned. If nothing is present, then an empty shape is returned.</p>",
"GetUser": "<p>Gets the user attributes and metadata for a user.</p>",
"GetUserAttributeVerificationCode": "<p>Gets the user attribute verification code for the specified attribute name.</p>",
"GlobalSignOut": "<p>Signs out users from all devices.</p>",
@@ -58,6 +64,7 @@
"ListDevices": "<p>Lists the devices.</p>",
"ListGroups": "<p>Lists the groups associated with a user pool.</p> <p>Requires developer credentials.</p>",
"ListIdentityProviders": "<p>Lists information about all identity providers for a user pool.</p>",
"ListResourceServers": "<p>Lists the resource servers for a user pool.</p>",
"ListUserImportJobs": "<p>Lists the user import jobs.</p>",
"ListUserPoolClients": "<p>Lists the clients that have been created for the specified user pool.</p>",
"ListUserPools": "<p>Lists the user pools associated with an AWS account.</p>",
@@ -65,6 +72,7 @@
"ListUsersInGroup": "<p>Lists the users in the specified group.</p> <p>Requires developer credentials.</p>",
"ResendConfirmationCode": "<p>Resends the confirmation (for confirmation of registration) to a specific user in the user pool.</p>",
"RespondToAuthChallenge": "<p>Responds to the authentication challenge.</p>",
"SetUICustomization": "<p>Sets the UI customization information for a user pool's built-in app UI.</p> <p>You can specify app UI customization settings for a single client (with a specific <code>clientId</code>) or for all clients (by setting the <code>clientId</code> to <code>ALL</code>). If you specify <code>ALL</code>, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the <code>ALL</code> configuration. </p> <note> <p>To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.</p> </note>",
"SetUserSettings": "<p>Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.</p>",
"SignUp": "<p>Registers the user in the specified user pool and creates a user name, password, and user attributes.</p>",
"StartUserImportJob": "<p>Starts the user import.</p>",
@@ -72,6 +80,7 @@
"UpdateDeviceStatus": "<p>Updates the device status.</p>",
"UpdateGroup": "<p>Updates the specified group with the specified attributes.</p> <p>Requires developer credentials.</p>",
"UpdateIdentityProvider": "<p>Updates identity provider information for a user pool.</p>",
"UpdateResourceServer": "<p>Updates the name and scopes of resource server. All other fields are read-only.</p>",
"UpdateUserAttributes": "<p>Allows a user to update a specific attribute (one at a time).</p>",
"UpdateUserPool": "<p>Updates the specified user pool with the specified attributes.</p>",
"UpdateUserPoolClient": "<p>Allows the developer to update the specified user pool client and password policy.</p>",
@@ -148,6 +157,16 @@
"refs": {
}
},
"AdminDisableProviderForUserRequest": {
"base": null,
"refs": {
}
},
"AdminDisableProviderForUserResponse": {
"base": null,
"refs": {
}
},
"AdminDisableUserRequest": {
"base": "<p>Represents the request to disable any user as an administrator.</p>",
"refs": {
@@ -203,6 +222,16 @@
"refs": {
}
},
"AdminLinkProviderForUserRequest": {
"base": null,
"refs": {
}
},
"AdminLinkProviderForUserResponse": {
"base": null,
"refs": {
}
},
"AdminListDevicesRequest": {
"base": "<p>Represents the request to list devices, as an administrator.</p>",
"refs": {
@@ -348,6 +377,12 @@
"UserType$Attributes": "<p>A container with information about the user type attributes.</p>"
}
},
"AttributeMappingKeyType": {
"base": null,
"refs": {
"AttributeMappingType$key": null
}
},
"AttributeMappingType": {
"base": null,
"refs": {
@@ -432,6 +467,19 @@
"UserType$Enabled": "<p>Specifies whether the user is enabled.</p>"
}
},
"CSSType": {
"base": null,
"refs": {
"SetUICustomizationRequest$CSS": "<p>The CSS values in the UI customization.</p>",
"UICustomizationType$CSS": "<p>The CSS values in the UI customization.</p>"
}
},
"CSSVersionType": {
"base": null,
"refs": {
"UICustomizationType$CSSVersion": "<p>The CSS version number.</p>"
}
},
"CallbackURLsListType": {
"base": null,
"refs": {
@@ -482,15 +530,18 @@
"refs": {
"AdminInitiateAuthRequest$ClientId": "<p>The app client ID.</p>",
"AdminRespondToAuthChallengeRequest$ClientId": "<p>The app client ID.</p>",
"ConfirmForgotPasswordRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"ConfirmSignUpRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"DeleteUserPoolClientRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"DescribeUserPoolClientRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"ConfirmForgotPasswordRequest$ClientId": "<p>The app client ID of the app associated with the user pool.</p>",
"ConfirmSignUpRequest$ClientId": "<p>The ID of the app client associated with the user pool.</p>",
"DeleteUserPoolClientRequest$ClientId": "<p>The app client ID of the app associated with the user pool.</p>",
"DescribeUserPoolClientRequest$ClientId": "<p>The app client ID of the app associated with the user pool.</p>",
"ForgotPasswordRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"GetUICustomizationRequest$ClientId": "<p>The client ID for the client app.</p>",
"InitiateAuthRequest$ClientId": "<p>The app client ID.</p>",
"ResendConfirmationCodeRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"RespondToAuthChallengeRequest$ClientId": "<p>The app client ID.</p>",
"SetUICustomizationRequest$ClientId": "<p>The client ID for the client app.</p>",
"SignUpRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"UICustomizationType$ClientId": "<p>The client ID for the client app.</p>",
"UpdateUserPoolClientRequest$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"UserPoolClientDescription$ClientId": "<p>The ID of the client associated with the user pool.</p>",
"UserPoolClientType$ClientId": "<p>The ID of the client associated with the user pool.</p>"
@@ -630,6 +681,16 @@
"refs": {
}
},
"CreateResourceServerRequest": {
"base": null,
"refs": {
}
},
"CreateResourceServerResponse": {
"base": null,
"refs": {
}
},
"CreateUserImportJobRequest": {
"base": "<p>Represents the request to create the user import job.</p>",
"refs": {
@@ -673,7 +734,6 @@
"CustomAttributeNameType": {
"base": null,
"refs": {
"AttributeMappingType$key": null,
"SchemaAttributeType$Name": "<p>A schema attribute of the name type.</p>"
}
},
@@ -697,6 +757,8 @@
"IdentityProviderType$CreationDate": "<p>The date the identity provider was created.</p>",
"ProviderDescription$LastModifiedDate": "<p>The date the provider was last modified.</p>",
"ProviderDescription$CreationDate": "<p>The date the provider was added to the user pool.</p>",
"UICustomizationType$LastModifiedDate": "<p>The last-modified date for the UI customization.</p>",
"UICustomizationType$CreationDate": "<p>The creation date for the UI customization.</p>",
"UserImportJobType$CreationDate": "<p>The date the user import job was created.</p>",
"UserImportJobType$StartDate": "<p>The date when the user import job was started.</p>",
"UserImportJobType$CompletionDate": "<p>The date when the user import job was completed.</p>",
@@ -710,6 +772,12 @@
"UserType$UserLastModifiedDate": "<p>The last modified date of the user.</p>"
}
},
"DefaultEmailOptionType": {
"base": null,
"refs": {
"VerificationMessageTemplateType$DefaultEmailOption": "<p>The default email option.</p>"
}
},
"DeleteGroupRequest": {
"base": null,
"refs": {
@@ -720,6 +788,11 @@
"refs": {
}
},
"DeleteResourceServerRequest": {
"base": null,
"refs": {
}
},
"DeleteUserAttributesRequest": {
"base": "<p>Represents the request to delete user attributes.</p>",
"refs": {
@@ -779,6 +852,16 @@
"refs": {
}
},
"DescribeResourceServerRequest": {
"base": null,
"refs": {
}
},
"DescribeResourceServerResponse": {
"base": null,
"refs": {
}
},
"DescribeUserImportJobRequest": {
"base": "<p>Represents the request to describe the user import job.</p>",
"refs": {
@@ -929,13 +1012,26 @@
"UserPoolType$EmailConfiguration": "<p>The email configuration.</p>"
}
},
"EmailVerificationMessageByLinkType": {
"base": null,
"refs": {
"VerificationMessageTemplateType$EmailMessageByLink": "<p>The email message template for sending a confirmation link to the user.</p>"
}
},
"EmailVerificationMessageType": {
"base": null,
"refs": {
"CreateUserPoolRequest$EmailVerificationMessage": "<p>A string representing the email verification message.</p>",
"MessageTemplateType$EmailMessage": "<p>The message template for email messages.</p>",
"UpdateUserPoolRequest$EmailVerificationMessage": "<p>The contents of the email verification message.</p>",
"UserPoolType$EmailVerificationMessage": "<p>The contents of the email verification message.</p>"
"UserPoolType$EmailVerificationMessage": "<p>The contents of the email verification message.</p>",
"VerificationMessageTemplateType$EmailMessage": "<p>The email message template.</p>"
}
},
"EmailVerificationSubjectByLinkType": {
"base": null,
"refs": {
"VerificationMessageTemplateType$EmailSubjectByLink": "<p>The subject line for the email message template for sending a confirmation link to the user.</p>"
}
},
"EmailVerificationSubjectType": {
@@ -944,7 +1040,8 @@
"CreateUserPoolRequest$EmailVerificationSubject": "<p>A string representing the email verification subject.</p>",
"MessageTemplateType$EmailSubject": "<p>The subject line for email messages.</p>",
"UpdateUserPoolRequest$EmailVerificationSubject": "<p>The subject of the email verification message.</p>",
"UserPoolType$EmailVerificationSubject": "<p>The subject of the email verification message.</p>"
"UserPoolType$EmailVerificationSubject": "<p>The subject of the email verification message.</p>",
"VerificationMessageTemplateType$EmailSubject": "<p>The subject line for the email message template.</p>"
}
},
"ExpiredCodeException": {
@@ -1034,6 +1131,16 @@
"refs": {
}
},
"GetUICustomizationRequest": {
"base": null,
"refs": {
}
},
"GetUICustomizationResponse": {
"base": null,
"refs": {
}
},
"GetUserAttributeVerificationCodeRequest": {
"base": "<p>Represents the request to get user attribute verification.</p>",
"refs": {
@@ -1130,6 +1237,18 @@
"UpdateIdentityProviderRequest$IdpIdentifiers": "<p>A list of identity provider identifiers.</p>"
}
},
"ImageFileType": {
"base": null,
"refs": {
"SetUICustomizationRequest$ImageFile": "<p>The uploaded logo image for the UI customization.</p>"
}
},
"ImageUrlType": {
"base": null,
"refs": {
"UICustomizationType$ImageUrl": "<p>The logo image for the UI customization.</p>"
}
},
"InitiateAuthRequest": {
"base": "<p>Initiates the authentication request.</p>",
"refs": {
@@ -1248,6 +1367,22 @@
"ListIdentityProvidersRequest$MaxResults": "<p>The maximum number of identity providers to return.</p>"
}
},
"ListResourceServersLimitType": {
"base": null,
"refs": {
"ListResourceServersRequest$MaxResults": "<p>The maximum number of resource servers to return.</p>"
}
},
"ListResourceServersRequest": {
"base": null,
"refs": {
}
},
"ListResourceServersResponse": {
"base": null,
"refs": {
}
},
"ListUserImportJobsRequest": {
"base": "<p>Represents the request to list the user import jobs.</p>",
"refs": {
@@ -1302,8 +1437,8 @@
"base": null,
"refs": {
"CreateUserPoolClientRequest$LogoutURLs": "<p>A list of allowed logout URLs for the identity providers.</p>",
"UpdateUserPoolClientRequest$LogoutURLs": "<p>A list ofallowed logout URLs for the identity providers.</p>",
"UserPoolClientType$LogoutURLs": "<p>A list ofallowed logout URLs for the identity providers.</p>"
"UpdateUserPoolClientRequest$LogoutURLs": "<p>A list of allowed logout URLs for the identity providers.</p>",
"UserPoolClientType$LogoutURLs": "<p>A list of allowed logout URLs for the identity providers.</p>"
}
},
"LongType": {
@@ -1435,6 +1570,8 @@
"refs": {
"ListIdentityProvidersRequest$NextToken": "<p>A pagination token.</p>",
"ListIdentityProvidersResponse$NextToken": "<p>A pagination token.</p>",
"ListResourceServersRequest$NextToken": "<p>A pagination token.</p>",
"ListResourceServersResponse$NextToken": "<p>A pagination token.</p>",
"ListUserImportJobsRequest$PaginationToken": "<p>An identifier that was returned from the previous call to <code>ListUserImportJobs</code>, which can be used to return the next set of import jobs in the list.</p>",
"ListUserImportJobsResponse$PaginationToken": "<p>An identifier that can be used to return the next set of user import jobs in the list.</p>",
"ListUserPoolsRequest$NextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
@@ -1511,15 +1648,29 @@
"ProviderNameType": {
"base": null,
"refs": {
"CreateIdentityProviderRequest$ProviderName": "<p>The identity provider name.</p>",
"DeleteIdentityProviderRequest$ProviderName": "<p>The identity provider name.</p>",
"DescribeIdentityProviderRequest$ProviderName": "<p>The identity provider name.</p>",
"IdentityProviderType$ProviderName": "<p>The identity provider name.</p>",
"ProviderDescription$ProviderName": "<p>The identity provider name.</p>",
"ProviderUserIdentifierType$ProviderName": "<p>The name of the provider, for example, Facebook, Google, or Login with Amazon.</p>",
"SupportedIdentityProvidersListType$member": null,
"UpdateIdentityProviderRequest$ProviderName": "<p>The identity provider name.</p>"
}
},
"ProviderNameTypeV1": {
"base": null,
"refs": {
"CreateIdentityProviderRequest$ProviderName": "<p>The identity provider name.</p>"
}
},
"ProviderUserIdentifierType": {
"base": "<p>A container for information about an identity provider for a user pool.</p>",
"refs": {
"AdminDisableProviderForUserRequest$User": "<p>The user to be disabled.</p>",
"AdminLinkProviderForUserRequest$DestinationUser": "<p>The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.</p> <p>The <code>ProviderAttributeValue</code> for the <code>DestinationUser</code> must match the username for the user in the user pool. The <code>ProviderAttributeName</code> will always be ignored.</p>",
"AdminLinkProviderForUserRequest$SourceUser": "<p>An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.</p> <p>If the <code>SourceUser</code> is a federated social identity provider user (Facebook, Google, or Login with Amazon), you must set the <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>. For social identity providers, the <code>ProviderName</code> will be <code>Facebook</code>, <code>Google</code>, or <code>LoginWithAmazon</code>, and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for <code>id</code>, <code>sub</code>, and <code>user_id</code>, respectively. The <code>ProviderAttributeValue</code> for the user must be the same value as the <code>id</code>, <code>sub</code>, or <code>user_id</code> value found in the social identity provider token.</p> <p/> <p>For SAML, the <code>ProviderAttributeName</code> can be any value that matches a claim in the SAML assertion. If you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the <code>ProviderAttributeName</code>. If you set <code>ProviderAttributeName</code> to <code>Cognito_Subject</code>, Cognito will automatically parse the default unique identifier found in the subject from the SAML token.</p>"
}
},
"ProvidersListType": {
"base": null,
"refs": {
@@ -1576,6 +1727,65 @@
"refs": {
}
},
"ResourceServerIdentifierType": {
"base": null,
"refs": {
"CreateResourceServerRequest$Identifier": "<p>A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, <code>https://my-weather-api.example.com</code>.</p>",
"DeleteResourceServerRequest$Identifier": "<p>The identifier for the resource server.</p>",
"DescribeResourceServerRequest$Identifier": "<p>The identifier for the resource server</p>",
"ResourceServerType$Identifier": "<p>The identifier for the resource server.</p>",
"UpdateResourceServerRequest$Identifier": "<p>The identifier for the resource server.</p>"
}
},
"ResourceServerNameType": {
"base": null,
"refs": {
"CreateResourceServerRequest$Name": "<p>A friendly name for the resource server.</p>",
"ResourceServerType$Name": "<p>The name of the resource server.</p>",
"UpdateResourceServerRequest$Name": "<p>The name of the resource server.</p>"
}
},
"ResourceServerScopeDescriptionType": {
"base": null,
"refs": {
"ResourceServerScopeType$ScopeDescription": "<p>A description of the scope.</p>"
}
},
"ResourceServerScopeListType": {
"base": null,
"refs": {
"CreateResourceServerRequest$Scopes": "<p>A list of scopes. Each scope is map, where the keys are <code>name</code> and <code>description</code>.</p>",
"ResourceServerType$Scopes": "<p>A list of scopes that are defined for the resource server.</p>",
"UpdateResourceServerRequest$Scopes": "<p>The scope values to be set for the resource server.</p>"
}
},
"ResourceServerScopeNameType": {
"base": null,
"refs": {
"ResourceServerScopeType$ScopeName": "<p>The name of the scope.</p>"
}
},
"ResourceServerScopeType": {
"base": "<p>A resource server scope.</p>",
"refs": {
"ResourceServerScopeListType$member": null
}
},
"ResourceServerType": {
"base": "<p>A container for information about a resource server for a user pool.</p>",
"refs": {
"CreateResourceServerResponse$ResourceServer": "<p>The newly created resource server.</p>",
"DescribeResourceServerResponse$ResourceServer": "<p>The resource server.</p>",
"ResourceServersListType$member": null,
"UpdateResourceServerResponse$ResourceServer": "<p>The resource server.</p>"
}
},
"ResourceServersListType": {
"base": null,
"refs": {
"ListResourceServersResponse$ResourceServers": "<p>The resource servers.</p>"
}
},
"RespondToAuthChallengeRequest": {
"base": "<p>The request to respond to an authentication challenge.</p>",
"refs": {
@@ -1663,6 +1873,16 @@
"RespondToAuthChallengeResponse$Session": "<p>The session which should be passed both ways in challenge-response calls to the service. If the <a href=\"API_InitiateAuth.html\">InitiateAuth</a> or <a href=\"API_RespondToAuthChallenge.html\">RespondToAuthChallenge</a> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>"
}
},
"SetUICustomizationRequest": {
"base": null,
"refs": {
}
},
"SetUICustomizationResponse": {
"base": null,
"refs": {
}
},
"SetUserSettingsRequest": {
"base": "<p>Represents the request to set user settings.</p>",
"refs": {
@@ -1700,7 +1920,8 @@
"UpdateUserPoolRequest$SmsVerificationMessage": "<p>A container with information about the SMS verification message.</p>",
"UpdateUserPoolRequest$SmsAuthenticationMessage": "<p>The contents of the SMS authentication message.</p>",
"UserPoolType$SmsVerificationMessage": "<p>The contents of the SMS verification message.</p>",
"UserPoolType$SmsAuthenticationMessage": "<p>The contents of the SMS authentication message.</p>"
"UserPoolType$SmsAuthenticationMessage": "<p>The contents of the SMS authentication message.</p>",
"VerificationMessageTemplateType$SmsMessage": "<p>The SMS message template.</p>"
}
},
"StartUserImportJobRequest": {
@@ -1739,6 +1960,8 @@
"StringType": {
"base": null,
"refs": {
"AdminDisableProviderForUserRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"AdminLinkProviderForUserRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"AttributeMappingType$value": null,
"AuthParametersType$key": null,
"AuthParametersType$value": null,
@@ -1758,6 +1981,8 @@
"NumberAttributeConstraintsType$MaxValue": "<p>The maximum value of an attribute that is of the number data type.</p>",
"ProviderDetailsType$key": null,
"ProviderDetailsType$value": null,
"ProviderUserIdentifierType$ProviderAttributeName": "<p>The name of the provider attribute to link to, for example, <code>NameID</code>.</p>",
"ProviderUserIdentifierType$ProviderAttributeValue": "<p>The value of the provider attribute to link to, for example, <code>xxxxx_account</code>.</p>",
"SignUpResponse$UserSub": "<p>The UUID of the authenticated user. This is not the same as <code>username</code>.</p>",
"SmsConfigurationType$ExternalId": "<p>The external ID.</p>",
"StringAttributeConstraintsType$MinLength": "<p>The minimum length of an attribute value of the string type.</p>",
@@ -1808,6 +2033,13 @@
"refs": {
}
},
"UICustomizationType": {
"base": "<p>A container for the UI customization information for a user pool's built-in app UI.</p>",
"refs": {
"GetUICustomizationResponse$UICustomization": "<p>The UI customization information.</p>",
"SetUICustomizationResponse$UICustomization": "<p>The UI customization information.</p>"
}
},
"UnexpectedLambdaException": {
"base": "<p>This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.</p>",
"refs": {
@@ -1853,6 +2085,16 @@
"refs": {
}
},
"UpdateResourceServerRequest": {
"base": null,
"refs": {
}
},
"UpdateResourceServerResponse": {
"base": null,
"refs": {
}
},
"UpdateUserAttributesRequest": {
"base": "<p>Represents the request to update user attributes.</p>",
"refs": {
@@ -1960,7 +2202,7 @@
}
},
"UserPoolClientType": {
"base": "<p>A user pool of the client type.</p>",
"base": "<p>Contains information about a user pool client.</p>",
"refs": {
"CreateUserPoolClientResponse$UserPoolClient": "<p>The user pool client that was just created.</p>",
"DescribeUserPoolClientResponse$UserPoolClient": "<p>The user pool client from a server response to describe the user pool client.</p>",
@@ -1999,15 +2241,18 @@
"AdminUserGlobalSignOutRequest$UserPoolId": "<p>The user pool ID.</p>",
"CreateGroupRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"CreateIdentityProviderRequest$UserPoolId": "<p>The user pool ID.</p>",
"CreateResourceServerRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"CreateUserImportJobRequest$UserPoolId": "<p>The user pool ID for the user pool that the users are being imported into.</p>",
"CreateUserPoolClientRequest$UserPoolId": "<p>The user pool ID for the user pool where you want to create a user pool client.</p>",
"CreateUserPoolDomainRequest$UserPoolId": "<p>The user pool ID.</p>",
"DeleteGroupRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"DeleteIdentityProviderRequest$UserPoolId": "<p>The user pool ID.</p>",
"DeleteResourceServerRequest$UserPoolId": "<p>The user pool ID for the user pool that hosts the resource server.</p>",
"DeleteUserPoolClientRequest$UserPoolId": "<p>The user pool ID for the user pool where you want to delete the client.</p>",
"DeleteUserPoolDomainRequest$UserPoolId": "<p>The user pool ID.</p>",
"DeleteUserPoolRequest$UserPoolId": "<p>The user pool ID for the user pool you want to delete.</p>",
"DescribeIdentityProviderRequest$UserPoolId": "<p>The user pool ID.</p>",
"DescribeResourceServerRequest$UserPoolId": "<p>The user pool ID for the user pool that hosts the resource server.</p>",
"DescribeUserImportJobRequest$UserPoolId": "<p>The user pool ID for the user pool that the users are being imported into.</p>",
"DescribeUserPoolClientRequest$UserPoolId": "<p>The user pool ID for the user pool you want to describe.</p>",
"DescribeUserPoolRequest$UserPoolId": "<p>The user pool ID for the user pool you want to describe.</p>",
@@ -2016,18 +2261,24 @@
"GetCSVHeaderResponse$UserPoolId": "<p>The user pool ID for the user pool that the users are to be imported into.</p>",
"GetGroupRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"GetIdentityProviderByIdentifierRequest$UserPoolId": "<p>The user pool ID.</p>",
"GetUICustomizationRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"GroupType$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"IdentityProviderType$UserPoolId": "<p>The user pool ID.</p>",
"ListGroupsRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"ListIdentityProvidersRequest$UserPoolId": "<p>The user pool ID.</p>",
"ListResourceServersRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"ListUserImportJobsRequest$UserPoolId": "<p>The user pool ID for the user pool that the users are being imported into.</p>",
"ListUserPoolClientsRequest$UserPoolId": "<p>The user pool ID for the user pool where you want to list user pool clients.</p>",
"ListUsersInGroupRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"ListUsersRequest$UserPoolId": "<p>The user pool ID for the user pool on which the search should be performed.</p>",
"ResourceServerType$UserPoolId": "<p>The user pool ID for the user pool that hosts the resource server.</p>",
"SetUICustomizationRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"StartUserImportJobRequest$UserPoolId": "<p>The user pool ID for the user pool that the users are being imported into.</p>",
"StopUserImportJobRequest$UserPoolId": "<p>The user pool ID for the user pool that the users are being imported into.</p>",
"UICustomizationType$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"UpdateGroupRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"UpdateIdentityProviderRequest$UserPoolId": "<p>The user pool ID.</p>",
"UpdateResourceServerRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"UpdateUserPoolClientRequest$UserPoolId": "<p>The user pool ID for the user pool where you want to update the user pool client.</p>",
"UpdateUserPoolRequest$UserPoolId": "<p>The user pool ID for the user pool you want to update.</p>",
"UserImportJobType$UserPoolId": "<p>The user pool ID for the user pool that the users are being imported into.</p>",
@@ -2097,7 +2348,7 @@
"UserType": {
"base": "<p>The user type.</p>",
"refs": {
"AdminCreateUserResponse$User": "<p>The user returned in the request to create a new user.</p>",
"AdminCreateUserResponse$User": "<p>The newly created user.</p>",
"UsersListType$member": null
}
},
@@ -2157,6 +2408,14 @@
"ListUsersResponse$Users": "<p>The users returned in the request to list users.</p>"
}
},
"VerificationMessageTemplateType": {
"base": "<p>The template for verification messages.</p>",
"refs": {
"CreateUserPoolRequest$VerificationMessageTemplate": "<p>The template for the verification message that the user sees when the app requests permission to access the user's information.</p>",
"UpdateUserPoolRequest$VerificationMessageTemplate": "<p>The template for verification messages.</p>",
"UserPoolType$VerificationMessageTemplate": "<p>The template for verification messages.</p>"
}
},
"VerifiedAttributeType": {
"base": null,
"refs": {

67
vendor/github.com/aws/aws-sdk-go/models/apis/config/2014-11-12/api-2.json generated vendored
View File

@@ -222,6 +222,20 @@
{"shape":"InvalidParameterValueException"}
]
},
"GetDiscoveredResourceCounts":{
"name":"GetDiscoveredResourceCounts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDiscoveredResourceCountsRequest"},
"output":{"shape":"GetDiscoveredResourceCountsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidLimitException"},
{"shape":"InvalidNextTokenException"}
]
},
"GetResourceConfigHistory":{
"name":"GetResourceConfigHistory",
"http":{
@@ -359,6 +373,11 @@
"AllSupported":{"type":"boolean"},
"AvailabilityZone":{"type":"string"},
"AwsRegion":{"type":"string"},
"BaseResourceId":{
"type":"string",
"max":768,
"min":1
},
"Boolean":{"type":"boolean"},
"ChannelName":{
"type":"string",
@@ -394,7 +413,7 @@
"type":"structure",
"members":{
"ResourceType":{"shape":"StringWithCharLimit256"},
"ResourceId":{"shape":"StringWithCharLimit256"},
"ResourceId":{"shape":"BaseResourceId"},
"Compliance":{"shape":"Compliance"}
}
},
@@ -707,7 +726,7 @@
"type":"structure",
"members":{
"ResourceType":{"shape":"StringWithCharLimit256"},
"ResourceId":{"shape":"StringWithCharLimit256"},
"ResourceId":{"shape":"BaseResourceId"},
"ComplianceTypes":{"shape":"ComplianceTypes"},
"Limit":{"shape":"Limit"},
"NextToken":{"shape":"NextToken"}
@@ -813,7 +832,7 @@
],
"members":{
"ComplianceResourceType":{"shape":"StringWithCharLimit256"},
"ComplianceResourceId":{"shape":"StringWithCharLimit256"},
"ComplianceResourceId":{"shape":"BaseResourceId"},
"ComplianceType":{"shape":"ComplianceType"},
"Annotation":{"shape":"StringWithCharLimit256"},
"OrderingTimestamp":{"shape":"OrderingTimestamp"}
@@ -842,7 +861,7 @@
"members":{
"ConfigRuleName":{"shape":"StringWithCharLimit64"},
"ResourceType":{"shape":"StringWithCharLimit256"},
"ResourceId":{"shape":"StringWithCharLimit256"}
"ResourceId":{"shape":"BaseResourceId"}
}
},
"EvaluationResults":{
@@ -884,7 +903,7 @@
],
"members":{
"ResourceType":{"shape":"StringWithCharLimit256"},
"ResourceId":{"shape":"StringWithCharLimit256"},
"ResourceId":{"shape":"BaseResourceId"},
"ComplianceTypes":{"shape":"ComplianceTypes"},
"NextToken":{"shape":"String"}
}
@@ -914,6 +933,22 @@
"ComplianceSummariesByResourceType":{"shape":"ComplianceSummariesByResourceType"}
}
},
"GetDiscoveredResourceCountsRequest":{
"type":"structure",
"members":{
"resourceTypes":{"shape":"ResourceTypes"},
"limit":{"shape":"Limit"},
"nextToken":{"shape":"NextToken"}
}
},
"GetDiscoveredResourceCountsResponse":{
"type":"structure",
"members":{
"totalDiscoveredResources":{"shape":"Long"},
"resourceCounts":{"shape":"ResourceCounts"},
"nextToken":{"shape":"NextToken"}
}
},
"GetResourceConfigHistoryRequest":{
"type":"structure",
"required":[
@@ -1054,6 +1089,7 @@
"nextToken":{"shape":"NextToken"}
}
},
"Long":{"type":"long"},
"MaxNumberOfConfigRulesExceededException":{
"type":"structure",
"members":{
@@ -1225,6 +1261,17 @@
"member":{"shape":"Relationship"}
},
"RelationshipName":{"type":"string"},
"ResourceCount":{
"type":"structure",
"members":{
"resourceType":{"shape":"ResourceType"},
"count":{"shape":"Long"}
}
},
"ResourceCounts":{
"type":"list",
"member":{"shape":"ResourceCount"}
},
"ResourceCreationTime":{"type":"timestamp"},
"ResourceDeletionTime":{"type":"timestamp"},
"ResourceId":{"type":"string"},
@@ -1295,7 +1342,13 @@
"AWS::Redshift::ClusterSecurityGroup",
"AWS::Redshift::ClusterSubnetGroup",
"AWS::Redshift::EventSubscription",
"AWS::CloudWatch::Alarm"
"AWS::CloudWatch::Alarm",
"AWS::CloudFormation::Stack",
"AWS::DynamoDB::Table",
"AWS::AutoScaling::AutoScalingGroup",
"AWS::AutoScaling::LaunchConfiguration",
"AWS::AutoScaling::ScalingPolicy",
"AWS::AutoScaling::ScheduledAction"
]
},
"ResourceTypeList":{
@@ -1319,7 +1372,7 @@
"ComplianceResourceTypes":{"shape":"ComplianceResourceTypes"},
"TagKey":{"shape":"StringWithCharLimit128"},
"TagValue":{"shape":"StringWithCharLimit256"},
"ComplianceResourceId":{"shape":"StringWithCharLimit256"}
"ComplianceResourceId":{"shape":"BaseResourceId"}
}
},
"Source":{

64
vendor/github.com/aws/aws-sdk-go/models/apis/config/2014-11-12/docs-2.json generated vendored
View File

@@ -19,8 +19,9 @@
"GetComplianceDetailsByResource": "<p>Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.</p>",
"GetComplianceSummaryByConfigRule": "<p>Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.</p>",
"GetComplianceSummaryByResourceType": "<p>Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.</p>",
"GetResourceConfigHistory": "<p>Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval.</p> <p>The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter.</p> <note> <p>Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>.</p> </note>",
"ListDiscoveredResources": "<p>Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.</p> <note> <p>You can specify either resource IDs or a resource name but not both in the same request.</p> </note> <p>The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string, and to get the next page of results, run the request again and enter this string for the <code>nextToken</code> parameter.</p>",
"GetDiscoveredResourceCounts": "<p>Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account. </p> <p class=\"title\"> <b>Example</b> </p> <ol> <li> <p>AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.</p> </li> <li> <p>You make a call to the <code>GetDiscoveredResourceCounts</code> action and specify that you want all resource types. </p> </li> <li> <p>AWS Config returns the following:</p> <ul> <li> <p>The resource types (EC2 instances, IAM users, and S3 buckets)</p> </li> <li> <p>The number of each resource type (25, 20, and 15)</p> </li> <li> <p>The total number of all resources (60)</p> </li> </ul> </li> </ol> <p>The response is paginated. By default, AWS Config lists 100 <a>ResourceCount</a> objects on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string. To get the next page of results, run the request again and specify the string for the <code>nextToken</code> parameter.</p> <note> <p>If you make a call to the <a>GetDiscoveredResourceCounts</a> action, you may not immediately receive resource counts in the following situations:</p> <ul> <li> <p>You are a new AWS Config customer</p> </li> <li> <p>You just enabled resource recording</p> </li> </ul> <p>It may take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the <a>GetDiscoveredResourceCounts</a> action. </p> </note>",
"GetResourceConfigHistory": "<p>Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval.</p> <p>The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string. To get the next page of results, run the request again and specify the string for the <code>nextToken</code> parameter.</p> <note> <p>Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified <code>limit</code>. In such cases, you can make another call, using the <code>nextToken</code>.</p> </note>",
"ListDiscoveredResources": "<p>Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.</p> <note> <p>You can specify either resource IDs or a resource name but not both in the same request.</p> </note> <p>The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize this number with the <code>limit</code> parameter. The response includes a <code>nextToken</code> string. To get the next page of results, run the request again and specify the string for the <code>nextToken</code> parameter.</p>",
"PutConfigRule": "<p>Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.</p> <p>You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.</p> <p>If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </p> <p>If you are adding an AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">About AWS Managed Config Rules</a>.</p> <p>For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules.</p> <p>If you are updating a rule that you added previously, you can specify the rule by <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request.</p> <p>The maximum number of rules that AWS Config supports is 50.</p> <p>For more information about requesting a rule limit increase, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config\">AWS Config Limits</a> in the <i>AWS General Reference Guide</i>.</p> <p>For more information about developing and using AWS Config rules, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html\">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>.</p>",
"PutConfigurationRecorder": "<p>Creates a new configuration recorder to record the selected resource configurations.</p> <p>You can use this action to change the role <code>roleARN</code> and/or the <code>recordingGroup</code> of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.</p> <note> <p>Currently, you can specify only one configuration recorder per region in your account.</p> <p>If <code>ConfigurationRecorder</code> does not have the <b>recordingGroup</b> parameter specified, the default is to record all supported resource types.</p> </note>",
"PutDeliveryChannel": "<p>Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.</p> <p>Before you can create a delivery channel, you must create a configuration recorder.</p> <p>You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.</p> <note> <p>You can have only one delivery channel per region in your account.</p> </note>",
@@ -60,6 +61,17 @@
"ConfigurationItem$awsRegion": "<p>The region where the resource resides.</p>"
}
},
"BaseResourceId": {
"base": null,
"refs": {
"ComplianceByResource$ResourceId": "<p>The ID of the AWS resource that was evaluated.</p>",
"DescribeComplianceByResourceRequest$ResourceId": "<p>The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for <code>ResourceType</code>.</p>",
"Evaluation$ComplianceResourceId": "<p>The ID of the AWS resource that was evaluated.</p>",
"EvaluationResultQualifier$ResourceId": "<p>The ID of the evaluated AWS resource.</p>",
"GetComplianceDetailsByResourceRequest$ResourceId": "<p>The ID of the AWS resource for which you want compliance information.</p>",
"Scope$ComplianceResourceId": "<p>The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for <code>ComplianceResourceTypes</code>.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
@@ -168,7 +180,7 @@
}
},
"ConfigExportDeliveryInfo": {
"base": "<p>A list that contains the status of the delivery of either the snapshot or the configuration history to the specified Amazon S3 bucket.</p>",
"base": "<p>Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.</p>",
"refs": {
"DeliveryChannelStatus$configSnapshotDeliveryInfo": "<p>A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.</p>",
"DeliveryChannelStatus$configHistoryDeliveryInfo": "<p>A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.</p>"
@@ -565,6 +577,16 @@
"refs": {
}
},
"GetDiscoveredResourceCountsRequest": {
"base": null,
"refs": {
}
},
"GetDiscoveredResourceCountsResponse": {
"base": null,
"refs": {
}
},
"GetResourceConfigHistoryRequest": {
"base": "<p>The input for the <a>GetResourceConfigHistory</a> action.</p>",
"refs": {
@@ -668,6 +690,7 @@
"refs": {
"DescribeComplianceByResourceRequest$Limit": "<p>The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</p>",
"GetComplianceDetailsByConfigRuleRequest$Limit": "<p>The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</p>",
"GetDiscoveredResourceCountsRequest$limit": "<p>The maximum number of <a>ResourceCount</a> objects returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</p>",
"GetResourceConfigHistoryRequest$limit": "<p>The maximum number of configuration items returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</p>",
"ListDiscoveredResourcesRequest$limit": "<p>The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.</p>"
}
@@ -687,6 +710,13 @@
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"GetDiscoveredResourceCountsResponse$totalDiscoveredResources": "<p>The total number of resources that AWS Config is recording in the region for your account. If you specify resource types in the request, AWS Config returns only the total number of resources for those resource types.</p> <p class=\"title\"> <b>Example</b> </p> <ol> <li> <p>AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.</p> </li> <li> <p>You make a call to the <code>GetDiscoveredResourceCounts</code> action and specify the resource type, <code>\"AWS::EC2::Instances\"</code> in the request.</p> </li> <li> <p>AWS Config returns 25 for <code>totalDiscoveredResources</code>.</p> </li> </ol>",
"ResourceCount$count": "<p>The number of resources.</p>"
}
},
"MaxNumberOfConfigRulesExceededException": {
"base": "<p>Failed to add the AWS Config rule because the account already contains the maximum number of 50 rules. Consider deleting any deactivated rules before adding new rules.</p>",
"refs": {
@@ -729,6 +759,8 @@
"DescribeComplianceByResourceResponse$NextToken": "<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>",
"GetComplianceDetailsByConfigRuleRequest$NextToken": "<p>The <code>NextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>",
"GetComplianceDetailsByConfigRuleResponse$NextToken": "<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>",
"GetDiscoveredResourceCountsRequest$nextToken": "<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>",
"GetDiscoveredResourceCountsResponse$nextToken": "<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>",
"GetResourceConfigHistoryRequest$nextToken": "<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>",
"GetResourceConfigHistoryResponse$nextToken": "<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>",
"ListDiscoveredResourcesRequest$nextToken": "<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>",
@@ -865,6 +897,18 @@
"Relationship$relationshipName": "<p>The type of relationship with the related resource.</p>"
}
},
"ResourceCount": {
"base": "<p>An object that contains the resource type and the number of resources.</p>",
"refs": {
"ResourceCounts$member": null
}
},
"ResourceCounts": {
"base": null,
"refs": {
"GetDiscoveredResourceCountsResponse$resourceCounts": "<p>The list of <code>ResourceCount</code> objects. Each object is listed in descending order by the number of resources.</p>"
}
},
"ResourceCreationTime": {
"base": null,
"refs": {
@@ -931,6 +975,7 @@
"GetResourceConfigHistoryRequest$resourceType": "<p>The resource type.</p>",
"ListDiscoveredResourcesRequest$resourceType": "<p>The type of resources that you want AWS Config to list in the response.</p>",
"Relationship$resourceType": "<p>The resource type of the related resource.</p>",
"ResourceCount$resourceType": "<p>The resource type, for example <code>\"AWS::EC2::Instance\"</code>.</p>",
"ResourceIdentifier$resourceType": "<p>The type of resource.</p>",
"ResourceTypeList$member": null
}
@@ -944,7 +989,8 @@
"ResourceTypes": {
"base": null,
"refs": {
"GetComplianceSummaryByResourceTypeRequest$ResourceTypes": "<p>Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.</p> <p>For this request, you can specify an AWS resource type such as <code>AWS::EC2::Instance</code>, and you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</p>"
"GetComplianceSummaryByResourceTypeRequest$ResourceTypes": "<p>Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.</p> <p>For this request, you can specify an AWS resource type such as <code>AWS::EC2::Instance</code>, and you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</p>",
"GetDiscoveredResourceCountsRequest$resourceTypes": "<p>The comma-separated list that specifies the resource types that you want the AWS Config to return. For example, (<code>\"AWS::EC2::Instance\"</code>, <code>\"AWS::IAM::User\"</code>).</p> <p>If a value for <code>resourceTypes</code> is not specified, AWS Config returns all resource types that AWS Config is recording in the region for your account.</p> <note> <p>If the configuration recorder is turned off, AWS Config returns an empty list of <a>ResourceCount</a> objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of <a>ResourceCount</a> objects.</p> </note>"
}
},
"RuleLimit": {
@@ -1040,30 +1086,24 @@
"StringWithCharLimit128": {
"base": null,
"refs": {
"Scope$TagKey": "<p>The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.</p>"
"Scope$TagKey": "<p>The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.</p>"
}
},
"StringWithCharLimit256": {
"base": null,
"refs": {
"ComplianceByResource$ResourceType": "<p>The type of the AWS resource that was evaluated.</p>",
"ComplianceByResource$ResourceId": "<p>The ID of the AWS resource that was evaluated.</p>",
"ComplianceResourceTypes$member": null,
"ComplianceSummaryByResourceType$ResourceType": "<p>The type of AWS resource.</p>",
"DescribeComplianceByResourceRequest$ResourceType": "<p>The types of AWS resources for which you want compliance information; for example, <code>AWS::EC2::Instance</code>. For this action, you can specify that the resource type is an AWS account by specifying <code>AWS::::Account</code>.</p>",
"DescribeComplianceByResourceRequest$ResourceId": "<p>The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for <code>ResourceType</code>.</p>",
"Evaluation$ComplianceResourceType": "<p>The type of AWS resource that was evaluated.</p>",
"Evaluation$ComplianceResourceId": "<p>The ID of the AWS resource that was evaluated.</p>",
"Evaluation$Annotation": "<p>Supplementary information about how the evaluation determined the compliance.</p>",
"EvaluationResult$Annotation": "<p>Supplementary information about how the evaluation determined the compliance.</p>",
"EvaluationResultQualifier$ResourceType": "<p>The type of AWS resource that was evaluated.</p>",
"EvaluationResultQualifier$ResourceId": "<p>The ID of the evaluated AWS resource.</p>",
"GetComplianceDetailsByResourceRequest$ResourceType": "<p>The type of the AWS resource for which you want compliance information.</p>",
"GetComplianceDetailsByResourceRequest$ResourceId": "<p>The ID of the AWS resource for which you want compliance information.</p>",
"ResourceTypes$member": null,
"Scope$TagValue": "<p>The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for <code>TagValue</code>, you must also specify a value for <code>TagKey</code>.</p>",
"Scope$ComplianceResourceId": "<p>The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for <code>ComplianceResourceTypes</code>.</p>",
"Source$SourceIdentifier": "<p>For AWS Config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p> <p>For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as <code>arn:aws:lambda:us-east-1:123456789012:function:custom_rule_name</code>.</p>"
"Source$SourceIdentifier": "<p>For AWS Config managed rules, a predefined identifier from a list. For example, <code>IAM_PASSWORD_POLICY</code> is a managed rule. To reference a managed rule, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p> <p>For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as <code>arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name</code>.</p>"
}
},
"StringWithCharLimit64": {

59
vendor/github.com/aws/aws-sdk-go/models/apis/devicefarm/2015-06-23/api-2.json generated vendored
View File

@@ -781,6 +781,10 @@
"type":"list",
"member":{"shape":"AmazonResourceName"}
},
"AndroidPaths":{
"type":"list",
"member":{"shape":"String"}
},
"AppPackagesCleanup":{"type":"boolean"},
"ArgumentException":{
"type":"structure",
@@ -834,7 +838,9 @@
"EXPLORER_SUMMARY_LOG",
"APPLICATION_CRASH_REPORT",
"XCTEST_LOG",
"VIDEO"
"VIDEO",
"CUSTOMER_ARTIFACT",
"CUSTOMER_ARTIFACT_LOG"
]
},
"Artifacts":{
@@ -857,6 +863,11 @@
"clock":{"shape":"Double"}
}
},
"ClientId":{
"type":"string",
"max":64,
"min":0
},
"ContentType":{
"type":"string",
"max":64,
@@ -950,7 +961,10 @@
"members":{
"projectArn":{"shape":"AmazonResourceName"},
"deviceArn":{"shape":"AmazonResourceName"},
"sshPublicKey":{"shape":"SshPublicKey"},
"remoteDebugEnabled":{"shape":"Boolean"},
"name":{"shape":"Name"},
"clientId":{"shape":"ClientId"},
"configuration":{"shape":"CreateRemoteAccessSessionConfiguration"}
}
},
@@ -984,6 +998,14 @@
"type":"string",
"enum":["USD"]
},
"CustomerArtifactPaths":{
"type":"structure",
"members":{
"iosPaths":{"shape":"IosPaths"},
"androidPaths":{"shape":"AndroidPaths"},
"deviceHostPaths":{"shape":"DeviceHostPaths"}
}
},
"DateTime":{"type":"timestamp"},
"DeleteDevicePoolRequest":{
"type":"structure",
@@ -1075,6 +1097,7 @@
"carrier":{"shape":"String"},
"radio":{"shape":"String"},
"remoteAccessEnabled":{"shape":"Boolean"},
"remoteDebugEnabled":{"shape":"Boolean"},
"fleetType":{"shape":"String"},
"fleetName":{"shape":"String"}
}
@@ -1087,6 +1110,7 @@
"FORM_FACTOR",
"MANUFACTURER",
"REMOTE_ACCESS_ENABLED",
"REMOTE_DEBUG_ENABLED",
"APPIUM_VERSION"
]
},
@@ -1097,6 +1121,10 @@
"TABLET"
]
},
"DeviceHostPaths":{
"type":"list",
"member":{"shape":"String"}
},
"DeviceMinutes":{
"type":"structure",
"members":{
@@ -1170,6 +1198,10 @@
"STOPPED"
]
},
"ExecutionResultCode":{
"type":"string",
"enum":["PARSING_FAILED"]
},
"ExecutionStatus":{
"type":"string",
"enum":[
@@ -1361,6 +1393,10 @@
"upload":{"shape":"Upload"}
}
},
"HostAddress":{
"type":"string",
"max":1024
},
"IdempotencyException":{
"type":"structure",
"members":{
@@ -1397,6 +1433,10 @@
}
},
"Integer":{"type":"integer"},
"IosPaths":{
"type":"list",
"member":{"shape":"String"}
},
"Job":{
"type":"structure",
"members":{
@@ -1919,9 +1959,13 @@
"started":{"shape":"DateTime"},
"stopped":{"shape":"DateTime"},
"device":{"shape":"Device"},
"remoteDebugEnabled":{"shape":"Boolean"},
"hostAddress":{"shape":"HostAddress"},
"clientId":{"shape":"ClientId"},
"billingMethod":{"shape":"BillingMethod"},
"deviceMinutes":{"shape":"DeviceMinutes"},
"endpoint":{"shape":"String"}
"endpoint":{"shape":"String"},
"deviceUdid":{"shape":"String"}
}
},
"RemoteAccessSessions":{
@@ -1989,7 +2033,10 @@
"completedJobs":{"shape":"Integer"},
"billingMethod":{"shape":"BillingMethod"},
"deviceMinutes":{"shape":"DeviceMinutes"},
"networkProfile":{"shape":"NetworkProfile"}
"networkProfile":{"shape":"NetworkProfile"},
"parsingResultUrl":{"shape":"String"},
"resultCode":{"shape":"ExecutionResultCode"},
"customerArtifactPaths":{"shape":"CustomerArtifactPaths"}
}
},
"Runs":{
@@ -2037,6 +2084,7 @@
"networkProfileArn":{"shape":"AmazonResourceName"},
"locale":{"shape":"String"},
"location":{"shape":"Location"},
"customerArtifactPaths":{"shape":"CustomerArtifactPaths"},
"radios":{"shape":"Radios"},
"auxiliaryApps":{"shape":"AmazonResourceNames"},
"billingMethod":{"shape":"BillingMethod"}
@@ -2082,6 +2130,11 @@
},
"exception":true
},
"SshPublicKey":{
"type":"string",
"max":8192,
"min":0
},
"StopRemoteAccessSessionRequest":{
"type":"structure",
"required":["arn"],

62
vendor/github.com/aws/aws-sdk-go/models/apis/devicefarm/2015-06-23/docs-2.json generated vendored
View File

@@ -145,6 +145,12 @@
"ScheduleRunConfiguration$auxiliaryApps": "<p>A list of auxiliary apps for the run.</p>"
}
},
"AndroidPaths": {
"base": null,
"refs": {
"CustomerArtifactPaths$androidPaths": "<p>Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.</p>"
}
},
"AppPackagesCleanup": {
"base": null,
"refs": {
@@ -192,12 +198,15 @@
"Boolean": {
"base": null,
"refs": {
"CreateRemoteAccessSessionRequest$remoteDebugEnabled": "<p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p>",
"Device$remoteAccessEnabled": "<p>Specifies whether remote access has been enabled for the specified device.</p>",
"Device$remoteDebugEnabled": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p>",
"DevicePoolCompatibilityResult$compatible": "<p>Whether the result was compatible with the device pool.</p>",
"Radios$wifi": "<p>True if Wi-Fi is enabled at the beginning of the test; otherwise, false.</p>",
"Radios$bluetooth": "<p>True if Bluetooth is enabled at the beginning of the test; otherwise, false.</p>",
"Radios$nfc": "<p>True if NFC is enabled at the beginning of the test; otherwise, false.</p>",
"Radios$gps": "<p>True if GPS is enabled at the beginning of the test; otherwise, false.</p>"
"Radios$gps": "<p>True if GPS is enabled at the beginning of the test; otherwise, false.</p>",
"RemoteAccessSession$remoteDebugEnabled": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p>"
}
},
"CPU": {
@@ -206,6 +215,13 @@
"Device$cpu": "<p>Information about the device's CPU.</p>"
}
},
"ClientId": {
"base": null,
"refs": {
"CreateRemoteAccessSessionRequest$clientId": "<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This is required only if <code>remoteDebugEnabled</code> is set to true <code>true</code>.</p>",
"RemoteAccessSession$clientId": "<p>Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.</p>"
}
},
"ContentType": {
"base": null,
"refs": {
@@ -284,6 +300,13 @@
"MonetaryAmount$currencyCode": "<p>The currency code of a monetary amount. For example, <code>USD</code> means \"U.S. dollars.\"</p>"
}
},
"CustomerArtifactPaths": {
"base": "<p>A JSON object specifying the paths where the artifacts generated by the customer's tests, on the device or in the test environment, will be pulled from.</p> <p>Specify <code>deviceHostPaths</code> and optionally specify either <code>iosPaths</code> or <code>androidPaths</code>.</p> <p>For web app tests, you can specify both <code>iosPaths</code> and <code>androidPaths</code>.</p>",
"refs": {
"Run$customerArtifactPaths": "<p>Output <code>CustomerArtifactPaths</code> object for the test run.</p>",
"ScheduleRunConfiguration$customerArtifactPaths": "<p>Input <code>CustomerArtifactPaths</code> object for the scheduled run configuration.</p>"
}
},
"DateTime": {
"base": null,
"refs": {
@@ -392,6 +415,12 @@
"Device$formFactor": "<p>The device's form factor.</p> <p>Allowed values include:</p> <ul> <li> <p>PHONE: The phone form factor.</p> </li> <li> <p>TABLET: The tablet form factor.</p> </li> </ul>"
}
},
"DeviceHostPaths": {
"base": null,
"refs": {
"CustomerArtifactPaths$deviceHostPaths": "<p>Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.</p>"
}
},
"DeviceMinutes": {
"base": "<p>Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.</p>",
"refs": {
@@ -484,6 +513,12 @@
"UniqueProblemsByExecutionResultMap$key": null
}
},
"ExecutionResultCode": {
"base": null,
"refs": {
"Run$resultCode": "<p>Supporting field for the result field. Set only if <code>result</code> is <code>SKIPPED</code>. <code>PARSING_FAILED</code> if the result is skipped because of test package parsing failure.</p>"
}
},
"ExecutionStatus": {
"base": null,
"refs": {
@@ -630,6 +665,12 @@
"refs": {
}
},
"HostAddress": {
"base": null,
"refs": {
"RemoteAccessSession$hostAddress": "<p>IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.</p>"
}
},
"IdempotencyException": {
"base": "<p>An entity with the same name already exists.</p>",
"refs": {
@@ -678,6 +719,12 @@
"Run$completedJobs": "<p>The total number of completed jobs.</p>"
}
},
"IosPaths": {
"base": null,
"refs": {
"CustomerArtifactPaths$iosPaths": "<p>Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.</p>"
}
},
"Job": {
"base": "<p>Represents a device.</p>",
"refs": {
@@ -1267,7 +1314,7 @@
}
},
"Run": {
"base": "<p>Represents an app on a set of devices with a specific test and configuration.</p>",
"base": "<p>Represents a test run on a set of devices with a given app package, test parameters, etc.</p>",
"refs": {
"GetRunResult$run": "<p>The run you wish to get results from.</p>",
"Runs$member": null,
@@ -1327,6 +1374,12 @@
"refs": {
}
},
"SshPublicKey": {
"base": null,
"refs": {
"CreateRemoteAccessSessionRequest$sshPublicKey": "<p>The public key of the <code>ssh</code> key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p>"
}
},
"StopRemoteAccessSessionRequest": {
"base": "<p>Represents the request to stop the remote access session.</p>",
"refs": {
@@ -1350,6 +1403,7 @@
"String": {
"base": null,
"refs": {
"AndroidPaths$member": null,
"Artifact$extension": "<p>The artifact's file extension.</p>",
"CPU$frequency": "<p>The CPU's frequency.</p>",
"CPU$architecture": "<p>The CPU's architecture, for example x86 or ARM.</p>",
@@ -1361,9 +1415,13 @@
"Device$radio": "<p>The device's radio.</p>",
"Device$fleetType": "<p>The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.</p>",
"Device$fleetName": "<p>The name of the fleet to which this device belongs.</p>",
"DeviceHostPaths$member": null,
"IosPaths$member": null,
"MaxSlotMap$key": null,
"RemoteAccessSession$endpoint": "<p>The endpoint for the remote access sesssion.</p>",
"RemoteAccessSession$deviceUdid": "<p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p>",
"Rule$value": "<p>The rule's value.</p>",
"Run$parsingResultUrl": "<p>Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.</p>",
"ScheduleRunConfiguration$locale": "<p>Information about the locale that is used for the run.</p>",
"TestParameters$key": null,
"TestParameters$value": null

20
vendor/github.com/aws/aws-sdk-go/models/apis/dynamodb/2012-08-10/docs-2.json generated vendored
View File

@@ -13,14 +13,14 @@
"GetItem": "<p>The <code>GetItem</code> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <code>GetItem</code> does not return any data and there will be no <code>Item</code> element in the response.</p> <p> <code>GetItem</code> provides an eventually consistent read by default. If your application requires a strongly consistent read, set <code>ConsistentRead</code> to <code>true</code>. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.</p>",
"ListTables": "<p>Returns an array of table names associated with the current account and endpoint. The output from <code>ListTables</code> is paginated, with each page returning a maximum of 100 table names.</p>",
"ListTagsOfResource": "<p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.</p> <p>For an overview on tagging DynamoDB resources, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html\">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"PutItem": "<p>Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.</p> <p>In addition to putting an item, you can also return the item's attribute values in the same operation, using the <code>ReturnValues</code> parameter.</p> <p>When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <code>ValidationException</code> exception.</p> <note> <p>To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists.</p> </note> <p>For more information about <code>PutItem</code>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html\">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"Query": "<p>A <code>Query</code> operation uses the primary key of a table or a secondary index to directly access items from that table or index.</p> <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for the partition key. The <code>Query</code> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <code>Query</code> operation by specifying a sort key value and a comparison operator in <code>KeyConditionExpression</code>. You can use the <code>ScanIndexForward</code> parameter to get results in forward or reverse order, by sort key.</p> <p>Queries that do not return results consume the minimum number of read capacity units for that type of read operation.</p> <p>If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the <code>LastEvaluatedKey</code> element to continue the query in a subsequent operation. Unlike a <code>Scan</code> operation, a <code>Query</code> operation never returns both an empty result set and a <code>LastEvaluatedKey</code> value. <code>LastEvaluatedKey</code> is only provided if you have used the <code>Limit</code> parameter, or if the result set exceeds 1 MB (prior to applying a filter). </p> <p>You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <code>ConsistentRead</code> when querying a global secondary index.</p>",
"Scan": "<p>The <code>Scan</code> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <code>FilterExpression</code> operation.</p> <p>If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <code>LastEvaluatedKey</code> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </p> <p>By default, <code>Scan</code> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <code>Scan</code> operation by providing the <code>Segment</code> and <code>TotalSegments</code> parameters. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#QueryAndScanParallelScan\">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p>By default, <code>Scan</code> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the <code>ConsistentRead</code> parameter to <code>true</code>.</p>",
"PutItem": "<p>Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the <code>ReturnValues</code> parameter.</p> <important> <p>This topic provides general information about the <code>PutItem</code> API.</p> <p>For information on how to call the <code>PutItem</code> API using the AWS SDK in specific languages, see the following:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/aws-cli/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS Command Line Interface </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/DotNetSDKV3/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for .NET </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for C++ </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForGoV1/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Go </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForJava/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Java </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/AWSJavaScriptSDK/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for JavaScript </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for PHP V3 </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Python </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Ruby V2 </a> </p> </li> </ul> </important> <p>When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <code>ValidationException</code> exception.</p> <note> <p>To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists.</p> </note> <p>For more information about <code>PutItem</code>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html\">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"Query": "<p>The <code>Query</code> operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key). </p> <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for the partition key. The <code>Query</code> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <code>Query</code> operation by specifying a sort key value and a comparison operator in <code>KeyConditionExpression</code>. To further refine the <code>Query</code> results, you can optionally provide a <code>FilterExpression</code>. A <code>FilterExpression</code> determines which items within the results should be returned to you. All of the other results are discarded. </p> <p> A <code>Query</code> operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation. </p> <note> <p> DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a <code>FilterExpression</code>. </p> </note> <p> <code>Query</code> results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the <code>ScanIndexForward</code> parameter to false. </p> <p> A single <code>Query</code> operation will read up to the maximum number of items set (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any filtering to the results using <code>FilterExpression</code>. If <code>LastEvaluatedKey</code> is present in the response, you will need to paginate the result set. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination\">Paginating the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p> <p> <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before the results are returned. A <code>FilterExpression</code> cannot contain partition key or sort key attributes. You need to specify those attributes in the <code>KeyConditionExpression</code>. </p> <note> <p> A <code>Query</code> operation can return an empty result set and a <code>LastEvaluatedKey</code> if all the items read for the page of results are filtered out. </p> </note> <p>You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <code>ConsistentRead</code> when querying a global secondary index.</p>",
"Scan": "<p>The <code>Scan</code> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <code>FilterExpression</code> operation.</p> <p>If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <code>LastEvaluatedKey</code> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </p> <p>A single <code>Scan</code> operation will read up to the maximum number of items set (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any filtering to the results using <code>FilterExpression</code>. If <code>LastEvaluatedKey</code> is present in the response, you will need to paginate the result set. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination\">Paginating the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p> <p> <code>Scan</code> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <code>Scan</code> operation by providing the <code>Segment</code> and <code>TotalSegments</code> parameters. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan\">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p> <code>Scan</code> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the <code>Scan</code> begins, you can set the <code>ConsistentRead</code> parameter to <code>true</code>.</p>",
"TagResource": "<p>Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to 5 times per second, per account. </p> <p>For an overview on tagging DynamoDB resources, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html\">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"UntagResource": "<p>Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account. </p> <p>For an overview on tagging DynamoDB resources, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html\">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"UpdateItem": "<p>Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).</p> <p>You can also return the item's attribute values in the same <code>UpdateItem</code> operation using the <code>ReturnValues</code> parameter.</p>",
"UpdateTable": "<p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.</p> <p>You can only perform one of the following operations at once:</p> <ul> <li> <p>Modify the provisioned throughput settings of the table.</p> </li> <li> <p>Enable or disable Streams on the table.</p> </li> <li> <p>Remove a global secondary index from the table.</p> </li> <li> <p>Create a new global secondary index on the table. Once the index begins backfilling, you can use <code>UpdateTable</code> to perform other operations.</p> </li> </ul> <p> <code>UpdateTable</code> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <code>UpdateTable</code> request. When the table returns to the <code>ACTIVE</code> state, the <code>UpdateTable</code> operation is complete.</p>",
"UpdateTimeToLive": "<p>Specify the lifetime of individual table items. The database automatically removes the item at the expiration of the item. The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful <code>UpdateTimeToLive</code> call returns the current <code>TimeToLiveSpecification</code>; it may take up to one hour for the change to fully process. </p> <p>TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.</p> <note> <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC. </p> </note> <p>DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. </p> <important> <p>DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.</p> </important> <p>As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html\">Time To Live</a> in the Amazon DynamoDB Developer Guide. </p>"
"UpdateTimeToLive": "<p>The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful <code>UpdateTimeToLive</code> call returns the current <code>TimeToLiveSpecification</code>; it may take up to one hour for the change to fully process. Any additional <code>UpdateTimeToLive</code> calls for the same table during this one hour duration result in a <code>ValidationException</code>. </p> <p>TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.</p> <note> <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC. </p> </note> <p>DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. </p> <important> <p>DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.</p> </important> <p>As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html\">Time To Live</a> in the Amazon DynamoDB Developer Guide. </p>"
},
"shapes": {
"AttributeAction": {
@@ -50,7 +50,7 @@
"GetItemOutput$Item": "<p>A map of attribute names to <code>AttributeValue</code> objects, as specified by <code>ProjectionExpression</code>.</p>",
"ItemList$member": null,
"PutItemOutput$Attributes": "<p>The attribute values as they appeared before the <code>PutItem</code> operation, but only if <code>ReturnValues</code> is specified as <code>ALL_OLD</code> in the request. Each element consists of an attribute name and an attribute value.</p>",
"UpdateItemOutput$Attributes": "<p>A map of attribute values as they appeared before the <code>UpdateItem</code> operation. This map only appears if <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the request. Each element represents one attribute.</p>"
"UpdateItemOutput$Attributes": "<p>A map of attribute values as they appear before or after the <code>UpdateItem</code> operation, as determined by the <code>ReturnValues</code> parameter.</p> <p>The <code>Attributes</code> map is only present if <code>ReturnValues</code> was specified as something other than <code>NONE</code> in the request. Each element represents one attribute.</p>"
}
},
"AttributeName": {
@@ -154,7 +154,7 @@
"BatchWriteItemRequestMap": {
"base": null,
"refs": {
"BatchWriteItemInput$RequestItems": "<p>A map of one or more table names and, for each table, a list of operations to be performed (<code>DeleteRequest</code> or <code>PutRequest</code>). Each element in the map consists of the following:</p> <ul> <li> <p> <code>DeleteRequest</code> - Perform a <code>DeleteItem</code> operation on the specified item. The item to be deleted is identified by a <code>Key</code> subelement:</p> <ul> <li> <p> <code>Key</code> - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key.</p> </li> </ul> </li> <li> <p> <code>PutRequest</code> - Perform a <code>PutItem</code> operation on the specified item. The item to be put is identified by an <code>Item</code> subelement:</p> <ul> <li> <p> <code>Item</code> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <code>ValidationException</code> exception.</p> <p>If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</p> </li> </ul> </li> </ul>",
"BatchWriteItemInput$RequestItems": "<p>A map of one or more table names and, for each table, a list of operations to be performed (<code>DeleteRequest</code> or <code>PutRequest</code>). Each element in the map consists of the following:</p> <ul> <li> <p> <code>DeleteRequest</code> - Perform a <code>DeleteItem</code> operation on the specified item. The item to be deleted is identified by a <code>Key</code> subelement:</p> <ul> <li> <p> <code>Key</code> - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide <i>all</i> of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for <i>both</i> the partition key and the sort key.</p> </li> </ul> </li> <li> <p> <code>PutRequest</code> - Perform a <code>PutItem</code> operation on the specified item. The item to be put is identified by an <code>Item</code> subelement:</p> <ul> <li> <p> <code>Item</code> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <code>ValidationException</code> exception.</p> <p>If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</p> </li> </ul> </li> </ul>",
"BatchWriteItemOutput$UnprocessedItems": "<p>A map of tables and requests against those tables that were not processed. The <code>UnprocessedItems</code> value is in the same form as <code>RequestItems</code>, so you can provide this value directly to a subsequent <code>BatchGetItem</code> operation. For more information, see <code>RequestItems</code> in the Request Parameters section.</p> <p>Each <code>UnprocessedItems</code> entry consists of a table name and, for that table, a list of operations to perform (<code>DeleteRequest</code> or <code>PutRequest</code>).</p> <ul> <li> <p> <code>DeleteRequest</code> - Perform a <code>DeleteItem</code> operation on the specified item. The item to be deleted is identified by a <code>Key</code> subelement:</p> <ul> <li> <p> <code>Key</code> - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.</p> </li> </ul> </li> <li> <p> <code>PutRequest</code> - Perform a <code>PutItem</code> operation on the specified item. The item to be put is identified by an <code>Item</code> subelement:</p> <ul> <li> <p> <code>Item</code> - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a <code>ValidationException</code> exception.</p> <p>If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.</p> </li> </ul> </li> </ul> <p>If there are no unprocessed items remaining, the response contains an empty <code>UnprocessedItems</code> map.</p>"
}
},
@@ -366,9 +366,9 @@
"ExpectedAttributeMap": {
"base": null,
"refs": {
"DeleteItemInput$Expected": "<p>This is a legacy parameter. Use <code>ConditionExpresssion</code> instead. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html\">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"PutItemInput$Expected": "<p>This is a legacy parameter. Use <code>ConditionExpresssion</code> instead. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html\">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"UpdateItemInput$Expected": "<p>This is a legacy parameter. Use <code>ConditionExpresssion</code> instead. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html\">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
"DeleteItemInput$Expected": "<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html\">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"PutItemInput$Expected": "<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html\">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"UpdateItemInput$Expected": "<p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html\">Expected</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
}
},
"ExpectedAttributeValue": {
@@ -882,7 +882,7 @@
"refs": {
"DeleteItemInput$ReturnValues": "<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appeared before they were deleted. For <code>DeleteItem</code>, the valid values are:</p> <ul> <li> <p> <code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p> </li> <li> <p> <code>ALL_OLD</code> - The content of the old item is returned.</p> </li> </ul> <note> <p>The <code>ReturnValues</code> parameter is used by several DynamoDB operations; however, <code>DeleteItem</code> does not recognize any values other than <code>NONE</code> or <code>ALL_OLD</code>.</p> </note>",
"PutItemInput$ReturnValues": "<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appeared before they were updated with the <code>PutItem</code> request. For <code>PutItem</code>, the valid values are:</p> <ul> <li> <p> <code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p> </li> <li> <p> <code>ALL_OLD</code> - If <code>PutItem</code> overwrote an attribute name-value pair, then the content of the old item is returned.</p> </li> </ul> <note> <p>The <code>ReturnValues</code> parameter is used by several DynamoDB operations; however, <code>PutItem</code> does not recognize any values other than <code>NONE</code> or <code>ALL_OLD</code>.</p> </note>",
"UpdateItemInput$ReturnValues": "<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appeared either before or after they were updated. For <code>UpdateItem</code>, the valid values are:</p> <ul> <li> <p> <code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p> </li> <li> <p> <code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p> </li> <li> <p> <code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p> </li> <li> <p> <code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p> </li> <li> <p> <code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p> </li> </ul> <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.</p> <p>Values returned are strongly consistent</p>"
"UpdateItemInput$ReturnValues": "<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear before or after they are updated. For <code>UpdateItem</code>, the valid values are:</p> <ul> <li> <p> <code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p> </li> <li> <p> <code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p> </li> <li> <p> <code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p> </li> <li> <p> <code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p> </li> <li> <p> <code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p> </li> </ul> <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.</p> <p>The values returned are strongly consistent.</p>"
}
},
"ScalarAttributeType": {

5
vendor/github.com/aws/aws-sdk-go/models/apis/dynamodb/2012-08-10/examples-1.json generated vendored
View File

@@ -548,13 +548,16 @@
"output": {
"Attributes": {
"AlbumTitle": {
"S": "Songs About Life"
"S": "Louder Than Ever"
},
"Artist": {
"S": "Acme Band"
},
"SongTitle": {
"S": "Happy Day"
},
"Year": {
"N": "2015"
}
}
},

605
vendor/github.com/aws/aws-sdk-go/models/apis/ec2/2016-11-15/api-2.json generated vendored
View File

@@ -256,6 +256,15 @@
"input":{"shape":"ConfirmProductInstanceRequest"},
"output":{"shape":"ConfirmProductInstanceResult"}
},
"CopyFpgaImage":{
"name":"CopyFpgaImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CopyFpgaImageRequest"},
"output":{"shape":"CopyFpgaImageResult"}
},
"CopyImage":{
"name":"CopyImage",
"http":{
@@ -283,6 +292,15 @@
"input":{"shape":"CreateCustomerGatewayRequest"},
"output":{"shape":"CreateCustomerGatewayResult"}
},
"CreateDefaultVpc":{
"name":"CreateDefaultVpc",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDefaultVpcRequest"},
"output":{"shape":"CreateDefaultVpcResult"}
},
"CreateDhcpOptions":{
"name":"CreateDhcpOptions",
"http":{
@@ -574,6 +592,15 @@
"input":{"shape":"DeleteFlowLogsRequest"},
"output":{"shape":"DeleteFlowLogsResult"}
},
"DeleteFpgaImage":{
"name":"DeleteFpgaImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFpgaImageRequest"},
"output":{"shape":"DeleteFpgaImageResult"}
},
"DeleteInternetGateway":{
"name":"DeleteInternetGateway",
"http":{
@@ -843,6 +870,15 @@
"input":{"shape":"DescribeEgressOnlyInternetGatewaysRequest"},
"output":{"shape":"DescribeEgressOnlyInternetGatewaysResult"}
},
"DescribeElasticGpus":{
"name":"DescribeElasticGpus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeElasticGpusRequest"},
"output":{"shape":"DescribeElasticGpusResult"}
},
"DescribeExportTasks":{
"name":"DescribeExportTasks",
"http":{
@@ -861,6 +897,15 @@
"input":{"shape":"DescribeFlowLogsRequest"},
"output":{"shape":"DescribeFlowLogsResult"}
},
"DescribeFpgaImageAttribute":{
"name":"DescribeFpgaImageAttribute",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeFpgaImageAttributeRequest"},
"output":{"shape":"DescribeFpgaImageAttributeResult"}
},
"DescribeFpgaImages":{
"name":"DescribeFpgaImages",
"http":{
@@ -1618,6 +1663,15 @@
"input":{"shape":"ImportVolumeRequest"},
"output":{"shape":"ImportVolumeResult"}
},
"ModifyFpgaImageAttribute":{
"name":"ModifyFpgaImageAttribute",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyFpgaImageAttributeRequest"},
"output":{"shape":"ModifyFpgaImageAttributeResult"}
},
"ModifyHosts":{
"name":"ModifyHosts",
"http":{
@@ -1910,6 +1964,15 @@
"input":{"shape":"RequestSpotInstancesRequest"},
"output":{"shape":"RequestSpotInstancesResult"}
},
"ResetFpgaImageAttribute":{
"name":"ResetFpgaImageAttribute",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResetFpgaImageAttributeRequest"},
"output":{"shape":"ResetFpgaImageAttributeResult"}
},
"ResetImageAttribute":{
"name":"ResetImageAttribute",
"http":{
@@ -2037,6 +2100,24 @@
},
"input":{"shape":"UnmonitorInstancesRequest"},
"output":{"shape":"UnmonitorInstancesResult"}
},
"UpdateSecurityGroupRuleDescriptionsEgress":{
"name":"UpdateSecurityGroupRuleDescriptionsEgress",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSecurityGroupRuleDescriptionsEgressRequest"},
"output":{"shape":"UpdateSecurityGroupRuleDescriptionsEgressResult"}
},
"UpdateSecurityGroupRuleDescriptionsIngress":{
"name":"UpdateSecurityGroupRuleDescriptionsIngress",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSecurityGroupRuleDescriptionsIngressRequest"},
"output":{"shape":"UpdateSecurityGroupRuleDescriptionsIngressResult"}
}
},
"shapes":{
@@ -2228,6 +2309,7 @@
"type":"structure",
"members":{
"Domain":{"shape":"DomainType"},
"Address":{"shape":"String"},
"DryRun":{
"shape":"Boolean",
"locationName":"dryRun"
@@ -2510,6 +2592,7 @@
"shape":"Boolean",
"locationName":"amazonProvidedIpv6CidrBlock"
},
"CidrBlock":{"shape":"String"},
"VpcId":{
"shape":"String",
"locationName":"vpcId"
@@ -2523,6 +2606,10 @@
"shape":"VpcIpv6CidrBlockAssociation",
"locationName":"ipv6CidrBlockAssociation"
},
"CidrBlockAssociation":{
"shape":"VpcCidrBlockAssociation",
"locationName":"cidrBlockAssociation"
},
"VpcId":{
"shape":"String",
"locationName":"vpcId"
@@ -3258,6 +3345,22 @@
"locationName":"item"
}
},
"CidrBlock":{
"type":"structure",
"members":{
"CidrBlock":{
"shape":"String",
"locationName":"cidrBlock"
}
}
},
"CidrBlockSet":{
"type":"list",
"member":{
"shape":"CidrBlock",
"locationName":"item"
}
},
"ClassicLinkDnsSupport":{
"type":"structure",
"members":{
@@ -3400,6 +3503,30 @@
"completed"
]
},
"CopyFpgaImageRequest":{
"type":"structure",
"required":[
"SourceFpgaImageId",
"SourceRegion"
],
"members":{
"DryRun":{"shape":"Boolean"},
"SourceFpgaImageId":{"shape":"String"},
"Description":{"shape":"String"},
"Name":{"shape":"String"},
"SourceRegion":{"shape":"String"},
"ClientToken":{"shape":"String"}
}
},
"CopyFpgaImageResult":{
"type":"structure",
"members":{
"FpgaImageId":{
"shape":"String",
"locationName":"fpgaImageId"
}
}
},
"CopyImageRequest":{
"type":"structure",
"required":[
@@ -3506,6 +3633,21 @@
}
}
},
"CreateDefaultVpcRequest":{
"type":"structure",
"members":{
"DryRun":{"shape":"Boolean"}
}
},
"CreateDefaultVpcResult":{
"type":"structure",
"members":{
"Vpc":{
"shape":"Vpc",
"locationName":"vpc"
}
}
},
"CreateDhcpOptionsRequest":{
"type":"structure",
"required":["DhcpConfigurations"],
@@ -4454,6 +4596,23 @@
}
}
},
"DeleteFpgaImageRequest":{
"type":"structure",
"required":["FpgaImageId"],
"members":{
"DryRun":{"shape":"Boolean"},
"FpgaImageId":{"shape":"String"}
}
},
"DeleteFpgaImageResult":{
"type":"structure",
"members":{
"Return":{
"shape":"Boolean",
"locationName":"return"
}
}
},
"DeleteInternetGatewayRequest":{
"type":"structure",
"required":["InternetGatewayId"],
@@ -5034,6 +5193,39 @@
}
}
},
"DescribeElasticGpusRequest":{
"type":"structure",
"members":{
"ElasticGpuIds":{
"shape":"ElasticGpuIdSet",
"locationName":"ElasticGpuId"
},
"DryRun":{"shape":"Boolean"},
"Filters":{
"shape":"FilterList",
"locationName":"Filter"
},
"MaxResults":{"shape":"Integer"},
"NextToken":{"shape":"String"}
}
},
"DescribeElasticGpusResult":{
"type":"structure",
"members":{
"ElasticGpuSet":{
"shape":"ElasticGpuSet",
"locationName":"elasticGpuSet"
},
"MaxResults":{
"shape":"Integer",
"locationName":"maxResults"
},
"NextToken":{
"shape":"String",
"locationName":"nextToken"
}
}
},
"DescribeExportTasksRequest":{
"type":"structure",
"members":{
@@ -5077,6 +5269,27 @@
}
}
},
"DescribeFpgaImageAttributeRequest":{
"type":"structure",
"required":[
"FpgaImageId",
"Attribute"
],
"members":{
"DryRun":{"shape":"Boolean"},
"FpgaImageId":{"shape":"String"},
"Attribute":{"shape":"FpgaImageAttributeName"}
}
},
"DescribeFpgaImageAttributeResult":{
"type":"structure",
"members":{
"FpgaImageAttribute":{
"shape":"FpgaImageAttribute",
"locationName":"fpgaImageAttribute"
}
}
},
"DescribeFpgaImagesRequest":{
"type":"structure",
"members":{
@@ -7103,6 +7316,10 @@
"shape":"VpcIpv6CidrBlockAssociation",
"locationName":"ipv6CidrBlockAssociation"
},
"CidrBlockAssociation":{
"shape":"VpcCidrBlockAssociation",
"locationName":"cidrBlockAssociation"
},
"VpcId":{
"shape":"String",
"locationName":"vpcId"
@@ -7290,6 +7507,111 @@
"locationName":"item"
}
},
"ElasticGpuAssociation":{
"type":"structure",
"members":{
"ElasticGpuId":{
"shape":"String",
"locationName":"elasticGpuId"
},
"ElasticGpuAssociationId":{
"shape":"String",
"locationName":"elasticGpuAssociationId"
},
"ElasticGpuAssociationState":{
"shape":"String",
"locationName":"elasticGpuAssociationState"
},
"ElasticGpuAssociationTime":{
"shape":"String",
"locationName":"elasticGpuAssociationTime"
}
}
},
"ElasticGpuAssociationList":{
"type":"list",
"member":{
"shape":"ElasticGpuAssociation",
"locationName":"item"
}
},
"ElasticGpuHealth":{
"type":"structure",
"members":{
"Status":{
"shape":"ElasticGpuStatus",
"locationName":"status"
}
}
},
"ElasticGpuIdSet":{
"type":"list",
"member":{
"shape":"String",
"locationName":"item"
}
},
"ElasticGpuSet":{
"type":"list",
"member":{
"shape":"ElasticGpus",
"locationName":"item"
}
},
"ElasticGpuSpecification":{
"type":"structure",
"required":["Type"],
"members":{
"Type":{"shape":"String"}
}
},
"ElasticGpuSpecifications":{
"type":"list",
"member":{
"shape":"ElasticGpuSpecification",
"locationName":"item"
}
},
"ElasticGpuState":{
"type":"string",
"enum":["ATTACHED"]
},
"ElasticGpuStatus":{
"type":"string",
"enum":[
"OK",
"IMPAIRED"
]
},
"ElasticGpus":{
"type":"structure",
"members":{
"ElasticGpuId":{
"shape":"String",
"locationName":"elasticGpuId"
},
"AvailabilityZone":{
"shape":"String",
"locationName":"availabilityZone"
},
"ElasticGpuType":{
"shape":"String",
"locationName":"elasticGpuType"
},
"ElasticGpuHealth":{
"shape":"ElasticGpuHealth",
"locationName":"elasticGpuHealth"
},
"ElasticGpuState":{
"shape":"ElasticGpuState",
"locationName":"elasticGpuState"
},
"InstanceId":{
"shape":"String",
"locationName":"instanceId"
}
}
},
"EnableVgwRoutePropagationRequest":{
"type":"structure",
"required":[
@@ -7639,9 +7961,47 @@
"Tags":{
"shape":"TagList",
"locationName":"tags"
},
"Public":{
"shape":"Boolean",
"locationName":"public"
}
}
},
"FpgaImageAttribute":{
"type":"structure",
"members":{
"FpgaImageId":{
"shape":"String",
"locationName":"fpgaImageId"
},
"Name":{
"shape":"String",
"locationName":"name"
},
"Description":{
"shape":"String",
"locationName":"description"
},
"LoadPermissions":{
"shape":"LoadPermissionList",
"locationName":"loadPermissions"
},
"ProductCodes":{
"shape":"ProductCodeList",
"locationName":"productCodes"
}
}
},
"FpgaImageAttributeName":{
"type":"string",
"enum":[
"description",
"name",
"loadPermission",
"productCodes"
]
},
"FpgaImageIdList":{
"type":"list",
"member":{
@@ -8021,7 +8381,10 @@
},
"HostOfferingSet":{
"type":"list",
"member":{"shape":"HostOffering"}
"member":{
"shape":"HostOffering",
"locationName":"item"
}
},
"HostProperties":{
"type":"structure",
@@ -8110,7 +8473,10 @@
},
"HostReservationSet":{
"type":"list",
"member":{"shape":"HostReservation"}
"member":{
"shape":"HostReservation",
"locationName":"item"
}
},
"HostTenancy":{
"type":"string",
@@ -8986,6 +9352,10 @@
"shape":"InstanceLifecycleType",
"locationName":"instanceLifecycle"
},
"ElasticGpuAssociations":{
"shape":"ElasticGpuAssociationList",
"locationName":"elasticGpuAssociationSet"
},
"NetworkInterfaces":{
"shape":"InstanceNetworkInterfaceList",
"locationName":"networkInterfaceSet"
@@ -9231,6 +9601,13 @@
"locationName":"InstanceId"
}
},
"InstanceInterruptionBehavior":{
"type":"string",
"enum":[
"stop",
"terminate"
]
},
"InstanceIpv6Address":{
"type":"structure",
"members":{
@@ -9676,6 +10053,7 @@
"r4.16xlarge",
"x1.16xlarge",
"x1.32xlarge",
"x1e.32xlarge",
"i2.xlarge",
"i2.2xlarge",
"i2.4xlarge",
@@ -9821,6 +10199,10 @@
"CidrIp":{
"shape":"String",
"locationName":"cidrIp"
},
"Description":{
"shape":"String",
"locationName":"description"
}
}
},
@@ -9868,6 +10250,10 @@
"CidrIpv6":{
"shape":"String",
"locationName":"cidrIpv6"
},
"Description":{
"shape":"String",
"locationName":"description"
}
}
},
@@ -10040,12 +10426,87 @@
"closed"
]
},
"LoadPermission":{
"type":"structure",
"members":{
"UserId":{
"shape":"String",
"locationName":"userId"
},
"Group":{
"shape":"PermissionGroup",
"locationName":"group"
}
}
},
"LoadPermissionList":{
"type":"list",
"member":{
"shape":"LoadPermission",
"locationName":"item"
}
},
"LoadPermissionListRequest":{
"type":"list",
"member":{
"shape":"LoadPermissionRequest",
"locationName":"item"
}
},
"LoadPermissionModifications":{
"type":"structure",
"members":{
"Add":{"shape":"LoadPermissionListRequest"},
"Remove":{"shape":"LoadPermissionListRequest"}
}
},
"LoadPermissionRequest":{
"type":"structure",
"members":{
"Group":{"shape":"PermissionGroup"},
"UserId":{"shape":"String"}
}
},
"Long":{"type":"long"},
"MaxResults":{
"type":"integer",
"max":255,
"min":5
},
"ModifyFpgaImageAttributeRequest":{
"type":"structure",
"required":["FpgaImageId"],
"members":{
"DryRun":{"shape":"Boolean"},
"FpgaImageId":{"shape":"String"},
"Attribute":{"shape":"FpgaImageAttributeName"},
"OperationType":{"shape":"OperationType"},
"UserIds":{
"shape":"UserIdStringList",
"locationName":"UserId"
},
"UserGroups":{
"shape":"UserGroupStringList",
"locationName":"UserGroup"
},
"ProductCodes":{
"shape":"ProductCodeStringList",
"locationName":"ProductCode"
},
"LoadPermission":{"shape":"LoadPermissionModifications"},
"Description":{"shape":"String"},
"Name":{"shape":"String"}
}
},
"ModifyFpgaImageAttributeResult":{
"type":"structure",
"members":{
"FpgaImageAttribute":{
"shape":"FpgaImageAttribute",
"locationName":"fpgaImageAttribute"
}
}
},
"ModifyHostsRequest":{
"type":"structure",
"required":[
@@ -10587,6 +11048,10 @@
"VpcId":{
"shape":"String",
"locationName":"vpcId"
},
"Tags":{
"shape":"TagList",
"locationName":"tagSet"
}
}
},
@@ -11264,6 +11729,10 @@
"PrefixListId":{
"type":"structure",
"members":{
"Description":{
"shape":"String",
"locationName":"description"
},
"PrefixListId":{
"shape":"String",
"locationName":"prefixListId"
@@ -12163,7 +12632,8 @@
"ValidUntil":{
"shape":"DateTime",
"locationName":"validUntil"
}
},
"InstanceInterruptionBehavior":{"shape":"InstanceInterruptionBehavior"}
}
},
"RequestSpotInstancesResult":{
@@ -12693,6 +13163,28 @@
"locationName":"item"
}
},
"ResetFpgaImageAttributeName":{
"type":"string",
"enum":["loadPermission"]
},
"ResetFpgaImageAttributeRequest":{
"type":"structure",
"required":["FpgaImageId"],
"members":{
"DryRun":{"shape":"Boolean"},
"FpgaImageId":{"shape":"String"},
"Attribute":{"shape":"ResetFpgaImageAttributeName"}
}
},
"ResetFpgaImageAttributeResult":{
"type":"structure",
"members":{
"Return":{
"shape":"Boolean",
"locationName":"return"
}
}
},
"ResetImageAttributeName":{
"type":"string",
"enum":["launchPermission"]
@@ -13125,6 +13617,7 @@
"shape":"String",
"locationName":"privateIpAddress"
},
"ElasticGpuSpecification":{"shape":"ElasticGpuSpecifications"},
"TagSpecifications":{
"shape":"TagSpecificationList",
"locationName":"TagSpecification"
@@ -13894,6 +14387,10 @@
"WeightedCapacity":{
"shape":"Double",
"locationName":"weightedCapacity"
},
"TagSpecifications":{
"shape":"SpotFleetTagSpecificationList",
"locationName":"tagSpecificationSet"
}
}
},
@@ -13997,6 +14494,10 @@
"ReplaceUnhealthyInstances":{
"shape":"Boolean",
"locationName":"replaceUnhealthyInstances"
},
"InstanceInterruptionBehavior":{
"shape":"InstanceInterruptionBehavior",
"locationName":"instanceInterruptionBehavior"
}
}
},
@@ -14007,6 +14508,26 @@
"locationName":"item"
}
},
"SpotFleetTagSpecification":{
"type":"structure",
"members":{
"ResourceType":{
"shape":"ResourceType",
"locationName":"resourceType"
},
"Tags":{
"shape":"TagList",
"locationName":"tag"
}
}
},
"SpotFleetTagSpecificationList":{
"type":"list",
"member":{
"shape":"SpotFleetTagSpecification",
"locationName":"item"
}
},
"SpotInstanceRequest":{
"type":"structure",
"members":{
@@ -14081,6 +14602,10 @@
"ValidUntil":{
"shape":"DateTime",
"locationName":"validUntil"
},
"InstanceInterruptionBehavior":{
"shape":"InstanceInterruptionBehavior",
"locationName":"instanceInterruptionBehavior"
}
}
},
@@ -14783,6 +15308,44 @@
"locationName":"item"
}
},
"UpdateSecurityGroupRuleDescriptionsEgressRequest":{
"type":"structure",
"required":["IpPermissions"],
"members":{
"DryRun":{"shape":"Boolean"},
"GroupId":{"shape":"String"},
"GroupName":{"shape":"String"},
"IpPermissions":{"shape":"IpPermissionList"}
}
},
"UpdateSecurityGroupRuleDescriptionsEgressResult":{
"type":"structure",
"members":{
"Return":{
"shape":"Boolean",
"locationName":"return"
}
}
},
"UpdateSecurityGroupRuleDescriptionsIngressRequest":{
"type":"structure",
"required":["IpPermissions"],
"members":{
"DryRun":{"shape":"Boolean"},
"GroupId":{"shape":"String"},
"GroupName":{"shape":"String"},
"IpPermissions":{"shape":"IpPermissionList"}
}
},
"UpdateSecurityGroupRuleDescriptionsIngressResult":{
"type":"structure",
"members":{
"Return":{
"shape":"Boolean",
"locationName":"return"
}
}
},
"UserBucket":{
"type":"structure",
"members":{
@@ -14822,6 +15385,10 @@
"UserIdGroupPair":{
"type":"structure",
"members":{
"Description":{
"shape":"String",
"locationName":"description"
},
"GroupId":{
"shape":"String",
"locationName":"groupId"
@@ -15301,6 +15868,10 @@
"shape":"VpcIpv6CidrBlockAssociationSet",
"locationName":"ipv6CidrBlockAssociationSet"
},
"CidrBlockAssociationSet":{
"shape":"VpcCidrBlockAssociationSet",
"locationName":"cidrBlockAssociationSet"
},
"IsDefault":{
"shape":"Boolean",
"locationName":"isDefault"
@@ -15338,6 +15909,30 @@
"enableDnsHostnames"
]
},
"VpcCidrBlockAssociation":{
"type":"structure",
"members":{
"AssociationId":{
"shape":"String",
"locationName":"associationId"
},
"CidrBlock":{
"shape":"String",
"locationName":"cidrBlock"
},
"CidrBlockState":{
"shape":"VpcCidrBlockState",
"locationName":"cidrBlockState"
}
}
},
"VpcCidrBlockAssociationSet":{
"type":"list",
"member":{
"shape":"VpcCidrBlockAssociation",
"locationName":"item"
}
},
"VpcCidrBlockState":{
"type":"structure",
"members":{
@@ -15562,6 +16157,10 @@
"shape":"Ipv6CidrBlockSet",
"locationName":"ipv6CidrBlockSet"
},
"CidrBlockSet":{
"shape":"CidrBlockSet",
"locationName":"cidrBlockSet"
},
"OwnerId":{
"shape":"String",
"locationName":"ownerId"

397
vendor/github.com/aws/aws-sdk-go/models/apis/ec2/2016-11-15/docs-2.json generated vendored
View File

File diff suppressed because one or more lines are too long

5
vendor/github.com/aws/aws-sdk-go/models/apis/ec2/2016-11-15/waiters-2.json generated vendored
View File

@@ -413,6 +413,11 @@
"matcher": "pathAny",
"argument": "SpotInstanceRequests[].Status.Code",
"expected": "system-error"
},
{
"state": "retry",
"matcher": "error",
"expected": "InvalidSpotInstanceRequestID.NotFound"
}
]
},

14
vendor/github.com/aws/aws-sdk-go/models/apis/ecs/2014-11-13/api-2.json generated vendored
View File

@@ -578,6 +578,7 @@
"environment":{"shape":"EnvironmentVariables"},
"mountPoints":{"shape":"MountPointList"},
"volumesFrom":{"shape":"VolumeFromList"},
"linuxParameters":{"shape":"LinuxParameters"},
"hostname":{"shape":"String"},
"user":{"shape":"String"},
"workingDirectory":{"shape":"String"},
@@ -918,6 +919,13 @@
},
"exception":true
},
"KernelCapabilities":{
"type":"structure",
"members":{
"add":{"shape":"StringList"},
"drop":{"shape":"StringList"}
}
},
"KeyValuePair":{
"type":"structure",
"members":{
@@ -925,6 +933,12 @@
"value":{"shape":"String"}
}
},
"LinuxParameters":{
"type":"structure",
"members":{
"capabilities":{"shape":"KernelCapabilities"}
}
},
"ListAttributesRequest":{
"type":"structure",
"required":["targetType"],

22
vendor/github.com/aws/aws-sdk-go/models/apis/ecs/2014-11-13/docs-2.json generated vendored
View File

@@ -78,7 +78,7 @@
"ContainerDefinition$disableNetworking": "<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a>.</p>",
"ContainerDefinition$privileged": "<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$readonlyRootFilesystem": "<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p>",
"DeregisterContainerInstanceRequest$force": "<p>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. </p> <p>Any containers in orphaned service tasks that are registered with a Classic load balancer or an Application load balancer target group are deregistered, and they will begin connection draining according to the settings on the load balancer or target group.</p>",
"DeregisterContainerInstanceRequest$force": "<p>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. </p> <p>Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered, and they will begin connection draining according to the settings on the load balancer or target group.</p>",
"MountPoint$readOnly": "<p>If this value is <code>true</code>, the container has read-only access to the volume. If this value is <code>false</code>, then the container can write to the volume. The default value is <code>false</code>.</p>",
"VolumeFrom$readOnly": "<p>If this value is <code>true</code>, the container has read-only access to the volume. If this value is <code>false</code>, then the container can write to the volume. The default value is <code>false</code>.</p>"
}
@@ -444,12 +444,24 @@
"refs": {
}
},
"KernelCapabilities": {
"base": "<p>The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see <a href=\"https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities\">Runtime privilege and Linux capabilities</a> in the <i>Docker run reference</i>. For more detailed information on these Linux capabilities, see the <a href=\"http://man7.org/linux/man-pages/man7/capabilities.7.html\">capabilities(7)</a> Linux manual page.</p>",
"refs": {
"LinuxParameters$capabilities": "<p>The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.</p>"
}
},
"KeyValuePair": {
"base": "<p>A key and value pair object.</p>",
"refs": {
"EnvironmentVariables$member": null
}
},
"LinuxParameters": {
"base": "<p>Linux-specific options that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p>",
"refs": {
"ContainerDefinition$linuxParameters": "<p>Linux-specific modifications that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p>"
}
},
"ListAttributesRequest": {
"base": null,
"refs": {
@@ -529,7 +541,7 @@
"LoadBalancers": {
"base": null,
"refs": {
"CreateServiceRequest$loadBalancers": "<p>A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.</p> <p>For Elastic Load Balancing Classic load balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.</p> <p>For Elastic Load Balancing Application load balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.</p>",
"CreateServiceRequest$loadBalancers": "<p>A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.</p>",
"Service$loadBalancers": "<p>A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.</p>"
}
},
@@ -797,7 +809,7 @@
"Container$lastStatus": "<p>The last known status of the container.</p>",
"Container$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
"ContainerDefinition$name": "<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>",
"ContainerDefinition$image": "<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>Images in Amazon ECR repositories use the full registry and repository URI (for example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;</code>). </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>",
"ContainerDefinition$image": "<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>Images in Amazon ECR repositories can be specified by either using the full <code>registry/repository:tag</code> or <code>registry/repository@digest</code>. For example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;:latest</code> or <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</code>. </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>",
"ContainerDefinition$hostname": "<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$user": "<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$workingDirectory": "<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
@@ -866,7 +878,7 @@
"ListTasksRequest$serviceName": "<p>The name of the service with which to filter the <code>ListTasks</code> results. Specifying a <code>serviceName</code> limits the results to tasks that belong to that service.</p>",
"ListTasksResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListTasks</code> request. When the results of a <code>ListTasks</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>",
"LoadBalancer$targetGroupArn": "<p>The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.</p>",
"LoadBalancer$loadBalancerName": "<p>The name of a Classic load balancer.</p>",
"LoadBalancer$loadBalancerName": "<p>The name of a load balancer.</p>",
"LoadBalancer$containerName": "<p>The name of the container (as it appears in a container definition) to associate with the load balancer.</p>",
"LogConfigurationOptionsMap$key": null,
"LogConfigurationOptionsMap$value": null,
@@ -957,6 +969,8 @@
"DescribeContainerInstancesRequest$containerInstances": "<p>A list of container instance IDs or full Amazon Resource Name (ARN) entries.</p>",
"DescribeServicesRequest$services": "<p>A list of services to describe. You may specify up to 10 services to describe in a single operation.</p>",
"DescribeTasksRequest$tasks": "<p>A list of up to 100 task IDs or full Amazon Resource Name (ARN) entries.</p>",
"KernelCapabilities$add": "<p>The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to <code>CapAdd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cap-add</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"KernelCapabilities$drop": "<p>The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to <code>CapDrop</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cap-drop</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ListClustersResponse$clusterArns": "<p>The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.</p>",
"ListContainerInstancesResponse$containerInstanceArns": "<p>The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.</p>",
"ListServicesResponse$serviceArns": "<p>The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.</p>",

11
vendor/github.com/aws/aws-sdk-go/models/apis/elasticbeanstalk/2010-12-01/api-2.json generated vendored
View File

@@ -1225,7 +1225,9 @@
"EnvironmentIds":{"shape":"EnvironmentIdList"},
"EnvironmentNames":{"shape":"EnvironmentNamesList"},
"IncludeDeleted":{"shape":"IncludeDeleted"},
"IncludedDeletedBackTo":{"shape":"IncludeDeletedBackTo"}
"IncludedDeletedBackTo":{"shape":"IncludeDeletedBackTo"},
"MaxRecords":{"shape":"MaxRecords"},
"NextToken":{"shape":"Token"}
}
},
"DescribeEventsMessage":{
@@ -1287,6 +1289,7 @@
"exception":true
},
"EndpointURL":{"type":"string"},
"EnvironmentArn":{"type":"string"},
"EnvironmentDescription":{
"type":"structure",
"members":{
@@ -1308,7 +1311,8 @@
"HealthStatus":{"shape":"EnvironmentHealthStatus"},
"Resources":{"shape":"EnvironmentResourcesDescription"},
"Tier":{"shape":"EnvironmentTier"},
"EnvironmentLinks":{"shape":"EnvironmentLinks"}
"EnvironmentLinks":{"shape":"EnvironmentLinks"},
"EnvironmentArn":{"shape":"EnvironmentArn"}
}
},
"EnvironmentDescriptionsList":{
@@ -1318,7 +1322,8 @@
"EnvironmentDescriptionsMessage":{
"type":"structure",
"members":{
"Environments":{"shape":"EnvironmentDescriptionsList"}
"Environments":{"shape":"EnvironmentDescriptionsList"},
"NextToken":{"shape":"Token"}
}
},
"EnvironmentHealth":{

29
vendor/github.com/aws/aws-sdk-go/models/apis/elasticbeanstalk/2010-12-01/docs-2.json generated vendored
View File

@@ -576,7 +576,7 @@
"DeploymentTimestamp": {
"base": null,
"refs": {
"Deployment$DeploymentTime": "<p>For in-progress deployments, the time that the deloyment started.</p> <p>For completed deployments, the time that the deployment ended.</p>"
"Deployment$DeploymentTime": "<p>For in-progress deployments, the time that the deployment started.</p> <p>For completed deployments, the time that the deployment ended.</p>"
}
},
"DescribeApplicationVersionsMessage": {
@@ -699,6 +699,12 @@
"EnvironmentDescription$EndpointURL": "<p>For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.</p>"
}
},
"EnvironmentArn": {
"base": null,
"refs": {
"EnvironmentDescription$EnvironmentArn": "<p>The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.</p>"
}
},
"EnvironmentDescription": {
"base": "<p>Describes the properties of an environment.</p>",
"refs": {
@@ -806,7 +812,7 @@
"refs": {
"AbortEnvironmentUpdateMessage$EnvironmentName": "<p>This specifies the name of the environment with the in-progress update that you want to cancel.</p>",
"ConfigurationSettingsDescription$EnvironmentName": "<p> If not <code>null</code>, the name of the environment for this configuration set. </p>",
"CreateEnvironmentMessage$EnvironmentName": "<p>A unique name for the deployment environment. Used in the application URL.</p> <p>Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.</p>",
"CreateEnvironmentMessage$EnvironmentName": "<p>A unique name for the deployment environment. Used in the application URL.</p> <p>Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an <code>InvalidParameterValue</code> error. </p> <p>Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.</p>",
"CreatePlatformVersionRequest$EnvironmentName": "<p>The name of the builder environment.</p>",
"DeleteEnvironmentConfigurationMessage$EnvironmentName": "<p>The name of the environment to delete the draft configuration from.</p>",
"DescribeConfigurationOptionsMessage$EnvironmentName": "<p>The name of the environment whose configuration options you want to describe.</p>",
@@ -1145,7 +1151,8 @@
"MaxRecords": {
"base": null,
"refs": {
"DescribeApplicationVersionsMessage$MaxRecords": "<p>Specify a maximum number of application versions to paginate in the request.</p>",
"DescribeApplicationVersionsMessage$MaxRecords": "<p>For a paginated request. Specify a maximum number of application versions to include in each response.</p> <p>If no <code>MaxRecords</code> is specified, all available application versions are retrieved in a single response.</p>",
"DescribeEnvironmentsMessage$MaxRecords": "<p>For a paginated request. Specify a maximum number of environments to include in each response.</p> <p>If no <code>MaxRecords</code> is specified, all available environments are retrieved in a single response.</p>",
"DescribeEventsMessage$MaxRecords": "<p>Specifies the maximum number of events that can be returned, beginning with the most recent event.</p>"
}
},
@@ -1283,16 +1290,16 @@
"PlatformArn": {
"base": null,
"refs": {
"ConfigurationOptionsDescription$PlatformArn": "<p>The ARN of the custom platform.</p>",
"ConfigurationSettingsDescription$PlatformArn": "<p>The ARN of the custom platform.</p>",
"ConfigurationOptionsDescription$PlatformArn": "<p>The ARN of the platform.</p>",
"ConfigurationSettingsDescription$PlatformArn": "<p>The ARN of the platform.</p>",
"CreateConfigurationTemplateMessage$PlatformArn": "<p>The ARN of the custome platform.</p>",
"CreateEnvironmentMessage$PlatformArn": "<p>The ARN of the custom platform.</p>",
"CreateEnvironmentMessage$PlatformArn": "<p>The ARN of the platform.</p>",
"DeletePlatformVersionRequest$PlatformArn": "<p>The ARN of the version of the custom platform.</p>",
"DescribeConfigurationOptionsMessage$PlatformArn": "<p>The ARN of the custom platform.</p>",
"DescribeEventsMessage$PlatformArn": "<p>The ARN of the version of the custom platform.</p>",
"DescribePlatformVersionRequest$PlatformArn": "<p>The ARN of the version of the platform.</p>",
"EnvironmentDescription$PlatformArn": "<p>The ARN of the custom platform.</p>",
"EventDescription$PlatformArn": "<p>The ARN of the custom platform.</p>",
"EnvironmentDescription$PlatformArn": "<p>The ARN of the platform.</p>",
"EventDescription$PlatformArn": "<p>The ARN of the platform.</p>",
"PlatformDescription$PlatformArn": "<p>The ARN of the platform.</p>",
"PlatformSummary$PlatformArn": "<p>The ARN of the platform.</p>",
"UpdateEnvironmentMessage$PlatformArn": "<p>The ARN of the platform, if used.</p>"
@@ -1768,9 +1775,11 @@
"Token": {
"base": null,
"refs": {
"ApplicationVersionDescriptionsMessage$NextToken": "<p>For a paginated request, the token that you can pass in a subsequent request to get the next page.</p>",
"DescribeApplicationVersionsMessage$NextToken": "<p>Specify a next token to retrieve the next page in a paginated request.</p>",
"ApplicationVersionDescriptionsMessage$NextToken": "<p>In a paginated request, the token that you can pass in a subsequent request to get the next response page.</p>",
"DescribeApplicationVersionsMessage$NextToken": "<p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p> <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>",
"DescribeEnvironmentsMessage$NextToken": "<p>For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.</p> <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>",
"DescribeEventsMessage$NextToken": "<p>Pagination token. If specified, the events return the next batch of results.</p>",
"EnvironmentDescriptionsMessage$NextToken": "<p>In a paginated request, the token that you can pass in a subsequent request to get the next response page.</p>",
"EventDescriptionsMessage$NextToken": "<p> If returned, this indicates that there are more results to obtain. Use this token in the next <a>DescribeEvents</a> call to get the next batch of events. </p>",
"ListPlatformVersionsRequest$NextToken": "<p>The starting index into the remaining list of platforms. Use the <code>NextToken</code> value from a previous <code>ListPlatformVersion</code> call.</p>",
"ListPlatformVersionsResult$NextToken": "<p>The starting index into the remaining list of platforms. if this value is not <code>null</code>, you can use it in a subsequent <code>ListPlatformVersion</code> call. </p>"

14
vendor/github.com/aws/aws-sdk-go/models/apis/elasticfilesystem/2015-02-01/api-2.json generated vendored
View File

@@ -205,7 +205,9 @@
"required":["CreationToken"],
"members":{
"CreationToken":{"shape":"CreationToken"},
"PerformanceMode":{"shape":"PerformanceMode"}
"PerformanceMode":{"shape":"PerformanceMode"},
"Encrypted":{"shape":"Encrypted"},
"KmsKeyId":{"shape":"KmsKeyId"}
}
},
"CreateMountTargetRequest":{
@@ -402,6 +404,7 @@
"NextMarker":{"shape":"Marker"}
}
},
"Encrypted":{"type":"boolean"},
"ErrorCode":{
"type":"string",
"min":1
@@ -442,7 +445,9 @@
"Name":{"shape":"TagValue"},
"NumberOfMountTargets":{"shape":"MountTargetCount"},
"SizeInBytes":{"shape":"FileSystemSize"},
"PerformanceMode":{"shape":"PerformanceMode"}
"PerformanceMode":{"shape":"PerformanceMode"},
"Encrypted":{"shape":"Encrypted"},
"KmsKeyId":{"shape":"KmsKeyId"}
}
},
"FileSystemDescriptions":{
@@ -533,6 +538,11 @@
"error":{"httpStatusCode":409},
"exception":true
},
"KmsKeyId":{
"type":"string",
"max":2048,
"min":1
},
"LifeCycleState":{
"type":"string",
"enum":[

16
vendor/github.com/aws/aws-sdk-go/models/apis/elasticfilesystem/2015-02-01/docs-2.json generated vendored
View File

@@ -110,6 +110,13 @@
"refs": {
}
},
"Encrypted": {
"base": null,
"refs": {
"CreateFileSystemRequest$Encrypted": "<p>A boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a <a>CreateFileSystemRequest$KmsKeyId</a> for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, <code>/aws/elasticfilesystem</code>, is used to protect the encrypted file system. </p>",
"FileSystemDescription$Encrypted": "<p>A boolean value that, if true, indicates that the file system is encrypted.</p>"
}
},
"ErrorCode": {
"base": null,
"refs": {
@@ -242,6 +249,13 @@
"refs": {
}
},
"KmsKeyId": {
"base": null,
"refs": {
"CreateFileSystemRequest$KmsKeyId": "<p>The id of the AWS KMS CMK that will be used to protect the encrypted file system. This parameter is only required if you want to use a non-default CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This id can be in one of the following formats:</p> <ul> <li> <p>Key ID - A unique identifier of the key. For example, <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>ARN - An Amazon Resource Name for the key. For example, <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p> </li> <li> <p>Key alias - A previously created display name for a key. For example, <code>alias/projectKey1</code>.</p> </li> <li> <p>Key alias ARN - An Amazon Resource Name for a key alias. For example, <code>arn:aws:kms:us-west-2:444455556666:alias/projectKey1</code>.</p> </li> </ul> <p>Note that if the KmsKeyId is specified, the <a>CreateFileSystemRequest$Encrypted</a> parameter must be set to true.</p>",
"FileSystemDescription$KmsKeyId": "<p>The id of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.</p>"
}
},
"LifeCycleState": {
"base": null,
"refs": {
@@ -414,7 +428,7 @@
}
},
"UnsupportedAvailabilityZone": {
"base": "<p></p>",
"base": "<p/>",
"refs": {
}
}

4
vendor/github.com/aws/aws-sdk-go/models/apis/elasticfilesystem/2015-02-01/paginators-1.json generated vendored Normal file
View File

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

119
vendor/github.com/aws/aws-sdk-go/models/apis/elasticloadbalancingv2/2015-12-01/api-2.json generated vendored
View File

@@ -52,7 +52,8 @@
{"shape":"SSLPolicyNotFoundException"},
{"shape":"CertificateNotFoundException"},
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
{"shape":"TooManyRegistrationsForTargetIdException"},
{"shape":"TooManyTargetsException"}
]
},
"CreateLoadBalancer":{
@@ -75,7 +76,10 @@
{"shape":"InvalidSecurityGroupException"},
{"shape":"InvalidSchemeException"},
{"shape":"TooManyTagsException"},
{"shape":"DuplicateTagKeysException"}
{"shape":"DuplicateTagKeysException"},
{"shape":"ResourceInUseException"},
{"shape":"AllocationIdNotFoundException"},
{"shape":"AvailabilityZoneNotSupportedException"}
]
},
"CreateRule":{
@@ -94,10 +98,12 @@
{"shape":"TooManyTargetGroupsException"},
{"shape":"TooManyRulesException"},
{"shape":"TargetGroupAssociationLimitException"},
{"shape":"IncompatibleProtocolsException"},
{"shape":"ListenerNotFoundException"},
{"shape":"TargetGroupNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
{"shape":"TooManyRegistrationsForTargetIdException"},
{"shape":"TooManyTargetsException"}
]
},
"CreateTargetGroup":{
@@ -113,7 +119,8 @@
},
"errors":[
{"shape":"DuplicateTargetGroupNameException"},
{"shape":"TooManyTargetGroupsException"}
{"shape":"TooManyTargetGroupsException"},
{"shape":"InvalidConfigurationRequestException"}
]
},
"DeleteListener":{
@@ -372,7 +379,8 @@
{"shape":"CertificateNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"UnsupportedProtocolException"},
{"shape":"TooManyRegistrationsForTargetIdException"}
{"shape":"TooManyRegistrationsForTargetIdException"},
{"shape":"TooManyTargetsException"}
]
},
"ModifyLoadBalancerAttributes":{
@@ -404,6 +412,7 @@
},
"errors":[
{"shape":"TargetGroupAssociationLimitException"},
{"shape":"IncompatibleProtocolsException"},
{"shape":"RuleNotFoundException"},
{"shape":"OperationNotPermittedException"},
{"shape":"TooManyRegistrationsForTargetIdException"},
@@ -423,7 +432,8 @@
"resultWrapper":"ModifyTargetGroupResult"
},
"errors":[
{"shape":"TargetGroupNotFoundException"}
{"shape":"TargetGroupNotFoundException"},
{"shape":"InvalidConfigurationRequestException"}
]
},
"ModifyTargetGroupAttributes":{
@@ -438,7 +448,8 @@
"resultWrapper":"ModifyTargetGroupAttributesResult"
},
"errors":[
{"shape":"TargetGroupNotFoundException"}
{"shape":"TargetGroupNotFoundException"},
{"shape":"InvalidConfigurationRequestException"}
]
},
"RegisterTargets":{
@@ -544,7 +555,9 @@
{"shape":"LoadBalancerNotFoundException"},
{"shape":"InvalidConfigurationRequestException"},
{"shape":"SubnetNotFoundException"},
{"shape":"InvalidSubnetException"}
{"shape":"InvalidSubnetException"},
{"shape":"AllocationIdNotFoundException"},
{"shape":"AvailabilityZoneNotSupportedException"}
]
}
},
@@ -584,13 +597,37 @@
"members":{
}
},
"AllocationId":{"type":"string"},
"AllocationIdNotFoundException":{
"type":"structure",
"members":{
},
"error":{
"code":"AllocationIdNotFound",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"AvailabilityZone":{
"type":"structure",
"members":{
"ZoneName":{"shape":"ZoneName"},
"SubnetId":{"shape":"SubnetId"}
"SubnetId":{"shape":"SubnetId"},
"LoadBalancerAddresses":{"shape":"LoadBalancerAddresses"}
}
},
"AvailabilityZoneNotSupportedException":{
"type":"structure",
"members":{
},
"error":{
"code":"AvailabilityZoneNotSupported",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"AvailabilityZones":{
"type":"list",
"member":{"shape":"AvailabilityZone"}
@@ -660,16 +697,15 @@
},
"CreateLoadBalancerInput":{
"type":"structure",
"required":[
"Name",
"Subnets"
],
"required":["Name"],
"members":{
"Name":{"shape":"LoadBalancerName"},
"Subnets":{"shape":"Subnets"},
"SubnetMappings":{"shape":"SubnetMappings"},
"SecurityGroups":{"shape":"SecurityGroups"},
"Scheme":{"shape":"LoadBalancerSchemeEnum"},
"Tags":{"shape":"TagList"},
"Type":{"shape":"LoadBalancerTypeEnum"},
"IpAddressType":{"shape":"IpAddressType"}
}
},
@@ -720,7 +756,8 @@
"HealthCheckTimeoutSeconds":{"shape":"HealthCheckTimeoutSeconds"},
"HealthyThresholdCount":{"shape":"HealthCheckThresholdCount"},
"UnhealthyThresholdCount":{"shape":"HealthCheckThresholdCount"},
"Matcher":{"shape":"Matcher"}
"Matcher":{"shape":"Matcher"},
"TargetType":{"shape":"TargetTypeEnum"}
}
},
"CreateTargetGroupOutput":{
@@ -1080,6 +1117,7 @@
},
"exception":true
},
"IpAddress":{"type":"string"},
"IpAddressType":{
"type":"string",
"enum":[
@@ -1152,6 +1190,17 @@
"IpAddressType":{"shape":"IpAddressType"}
}
},
"LoadBalancerAddress":{
"type":"structure",
"members":{
"IpAddress":{"shape":"IpAddress"},
"AllocationId":{"shape":"AllocationId"}
}
},
"LoadBalancerAddresses":{
"type":"list",
"member":{"shape":"LoadBalancerAddress"}
},
"LoadBalancerArn":{"type":"string"},
"LoadBalancerArns":{
"type":"list",
@@ -1213,12 +1262,16 @@
"enum":[
"active",
"provisioning",
"active_impaired",
"failed"
]
},
"LoadBalancerTypeEnum":{
"type":"string",
"enum":["application"]
"enum":[
"application",
"network"
]
},
"LoadBalancers":{
"type":"list",
@@ -1363,7 +1416,8 @@
"type":"string",
"enum":[
"HTTP",
"HTTPS"
"HTTPS",
"TCP"
]
},
"RegisterTargetsInput":{
@@ -1453,7 +1507,7 @@
},
"RulePriority":{
"type":"integer",
"max":99999,
"max":50000,
"min":1
},
"RulePriorityList":{
@@ -1542,7 +1596,8 @@
],
"members":{
"LoadBalancerArn":{"shape":"LoadBalancerArn"},
"Subnets":{"shape":"Subnets"}
"Subnets":{"shape":"Subnets"},
"SubnetMappings":{"shape":"SubnetMappings"}
}
},
"SetSubnetsOutput":{
@@ -1577,6 +1632,17 @@
"String":{"type":"string"},
"StringValue":{"type":"string"},
"SubnetId":{"type":"string"},
"SubnetMapping":{
"type":"structure",
"members":{
"SubnetId":{"shape":"SubnetId"},
"AllocationId":{"shape":"AllocationId"}
}
},
"SubnetMappings":{
"type":"list",
"member":{"shape":"SubnetMapping"}
},
"SubnetNotFoundException":{
"type":"structure",
"members":{
@@ -1637,7 +1703,8 @@
"required":["Id"],
"members":{
"Id":{"shape":"TargetId"},
"Port":{"shape":"Port"}
"Port":{"shape":"Port"},
"AvailabilityZone":{"shape":"ZoneName"}
}
},
"TargetDescriptions":{
@@ -1660,7 +1727,8 @@
"UnhealthyThresholdCount":{"shape":"HealthCheckThresholdCount"},
"HealthCheckPath":{"shape":"Path"},
"Matcher":{"shape":"Matcher"},
"LoadBalancerArns":{"shape":"LoadBalancerArns"}
"LoadBalancerArns":{"shape":"LoadBalancerArns"},
"TargetType":{"shape":"TargetTypeEnum"}
}
},
"TargetGroupArn":{"type":"string"},
@@ -1748,6 +1816,7 @@
"Target.NotInUse",
"Target.DeregistrationInProgress",
"Target.InvalidState",
"Target.IpUnusable",
"Elb.InternalError"
]
},
@@ -1758,10 +1827,18 @@
"healthy",
"unhealthy",
"unused",
"draining"
"draining",
"unavailable"
]
},
"TargetId":{"type":"string"},
"TargetTypeEnum":{
"type":"string",
"enum":[
"instance",
"ip"
]
},
"TooManyCertificatesException":{
"type":"structure",
"members":{

164
vendor/github.com/aws/aws-sdk-go/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json generated vendored
View File

@@ -1,38 +1,38 @@
{
"version": "2.0",
"service": "<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports two types of load balancers: Classic Load Balancers and Application Load Balancers. A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>This reference covers the 2015-12-01 API, which supports Application Load Balancers. The 2012-06-01 API supports Classic Load Balancers.</p> <p>To get started, complete the following tasks:</p> <ol> <li> <p>Create an Application Load Balancer using <a>CreateLoadBalancer</a>.</p> </li> <li> <p>Create a target group using <a>CreateTargetGroup</a>.</p> </li> <li> <p>Register targets for the target group using <a>RegisterTargets</a>.</p> </li> <li> <p>Create one or more listeners for your load balancer using <a>CreateListener</a>.</p> </li> <li> <p>(Optional) Create one or more rules for content routing based on URL using <a>CreateRule</a>.</p> </li> </ol> <p>To delete an Application Load Balancer and its related resources, complete the following tasks:</p> <ol> <li> <p>Delete the load balancer using <a>DeleteLoadBalancer</a>.</p> </li> <li> <p>Delete the target group using <a>DeleteTargetGroup</a>.</p> </li> </ol> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>",
"service": "<fullname>Elastic Load Balancing</fullname> <p>A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.</p> <p>Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers.</p> <p>An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC).</p> <p>A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. For more information, see the <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/userguide/\">Elastic Load Balancing User Guide</a>.</p> <p>This reference covers the 2015-12-01 API, which supports Application Load Balancers and Network Load Balancers. The 2012-06-01 API supports Classic Load Balancers.</p> <p>To get started, complete the following tasks:</p> <ol> <li> <p>Create a load balancer using <a>CreateLoadBalancer</a>.</p> </li> <li> <p>Create a target group using <a>CreateTargetGroup</a>.</p> </li> <li> <p>Register targets for the target group using <a>RegisterTargets</a>.</p> </li> <li> <p>Create one or more listeners for your load balancer using <a>CreateListener</a>.</p> </li> </ol> <p>To delete a load balancer and its related resources, complete the following tasks:</p> <ol> <li> <p>Delete the load balancer using <a>DeleteLoadBalancer</a>.</p> </li> <li> <p>Delete the target group using <a>DeleteTargetGroup</a>.</p> </li> </ol> <p>All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.</p>",
"operations": {
"AddTags": "<p>Adds the specified tags to the specified resource. You can tag your Application Load Balancers and your target groups.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, <code>AddTags</code> updates its value.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>. To remove tags from your resources, use <a>RemoveTags</a>.</p>",
"CreateListener": "<p>Creates a listener for the specified Application Load Balancer.</p> <p>You can create up to 10 listeners per load balancer.</p> <p>To update a listener, use <a>ModifyListener</a>. When you are finished with a listener, you can delete it using <a>DeleteListener</a>. If you are finished with both the listener and the load balancer, you can delete them both using <a>DeleteLoadBalancer</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>",
"CreateLoadBalancer": "<p>Creates an Application Load Balancer.</p> <p>When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using <a>SetSecurityGroups</a>, <a>SetSubnets</a>, <a>SetIpAddressType</a>, and <a>AddTags</a>.</p> <p>To create listeners for your load balancer, use <a>CreateListener</a>. To describe your current load balancers, see <a>DescribeLoadBalancers</a>. When you are finished with a load balancer, you can delete it using <a>DeleteLoadBalancer</a>.</p> <p>You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancers Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html\">Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>",
"CreateRule": "<p>Creates a rule for the specified listener.</p> <p>Each rule can have one action and one condition. Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the default action for the default rule is taken. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules\">Listener Rules</a> in the <i>Application Load Balancers Guide</i>.</p> <p>To view your current rules, use <a>DescribeRules</a>. To update a rule, use <a>ModifyRule</a>. To set the priorities of your rules, use <a>SetRulePriorities</a>. To delete a rule, use <a>DeleteRule</a>.</p>",
"CreateTargetGroup": "<p>Creates a target group.</p> <p>To register targets with the target group, use <a>RegisterTargets</a>. To update the health check settings for the target group, use <a>ModifyTargetGroup</a>. To monitor the health of targets in the target group, use <a>DescribeTargetHealth</a>.</p> <p>To route traffic to the targets in a target group, specify the target group in an action using <a>CreateListener</a> or <a>CreateRule</a>.</p> <p>To delete a target group, use <a>DeleteTargetGroup</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html\">Target Groups for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i>.</p>",
"AddTags": "<p>Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, <code>AddTags</code> updates its value.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>. To remove tags from your resources, use <a>RemoveTags</a>.</p>",
"CreateListener": "<p>Creates a listener for the specified Application Load Balancer or Network Load Balancer.</p> <p>You can create up to 10 listeners per load balancer.</p> <p>To update a listener, use <a>ModifyListener</a>. When you are finished with a listener, you can delete it using <a>DeleteListener</a>. If you are finished with both the listener and the load balancer, you can delete them both using <a>DeleteLoadBalancer</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> and <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html\">Listeners for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>",
"CreateLoadBalancer": "<p>Creates an Application Load Balancer or a Network Load Balancer.</p> <p>When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using <a>SetSecurityGroups</a>, <a>SetSubnets</a>, <a>SetIpAddressType</a>, and <a>AddTags</a>.</p> <p>To create listeners for your load balancer, use <a>CreateListener</a>. To describe your current load balancers, see <a>DescribeLoadBalancers</a>. When you are finished with a load balancer, you can delete it using <a>DeleteLoadBalancer</a>.</p> <p>You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancers Guide</i> and <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html\">Limits for Your Network Load Balancer</a> in the <i>Network Load Balancers Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html\">Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> and <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html\">Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>",
"CreateRule": "<p>Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.</p> <p>Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the action for the default rule is taken. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules\">Listener Rules</a> in the <i>Application Load Balancers Guide</i>.</p> <p>To view your current rules, use <a>DescribeRules</a>. To update a rule, use <a>ModifyRule</a>. To set the priorities of your rules, use <a>SetRulePriorities</a>. To delete a rule, use <a>DeleteRule</a>.</p>",
"CreateTargetGroup": "<p>Creates a target group.</p> <p>To register targets with the target group, use <a>RegisterTargets</a>. To update the health check settings for the target group, use <a>ModifyTargetGroup</a>. To monitor the health of targets in the target group, use <a>DescribeTargetHealth</a>.</p> <p>To route traffic to the targets in a target group, specify the target group in an action using <a>CreateListener</a> or <a>CreateRule</a>.</p> <p>To delete a target group, use <a>DeleteTargetGroup</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html\">Target Groups for Your Application Load Balancers</a> in the <i>Application Load Balancers Guide</i> or <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html\">Target Groups for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>",
"DeleteListener": "<p>Deletes the specified listener.</p> <p>Alternatively, your listener is deleted when you delete the load balancer it is attached to using <a>DeleteLoadBalancer</a>.</p>",
"DeleteLoadBalancer": "<p>Deletes the specified Application Load Balancer and its attached listeners.</p> <p>You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.</p> <p>Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.</p>",
"DeleteLoadBalancer": "<p>Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.</p> <p>You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.</p> <p>Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.</p>",
"DeleteRule": "<p>Deletes the specified rule.</p>",
"DeleteTargetGroup": "<p>Deletes the specified target group.</p> <p>You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.</p>",
"DeregisterTargets": "<p>Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.</p>",
"DescribeAccountLimits": "<p>Describes the current Elastic Load Balancing resource limits for your AWS account.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancer</a> in the <i>Application Load Balancer Guide</i>.</p>",
"DescribeListeners": "<p>Describes the specified listeners or the listeners for the specified Application Load Balancer. You must specify either a load balancer or one or more listeners.</p>",
"DescribeLoadBalancerAttributes": "<p>Describes the attributes for the specified Application Load Balancer.</p>",
"DescribeLoadBalancers": "<p>Describes the specified Application Load Balancers or all of your Application Load Balancers.</p> <p>To describe the listeners for a load balancer, use <a>DescribeListeners</a>. To describe the attributes for a load balancer, use <a>DescribeLoadBalancerAttributes</a>.</p>",
"DescribeAccountLimits": "<p>Describes the current Elastic Load Balancing resource limits for your AWS account.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-limits.html\">Limits for Your Application Load Balancers</a> in the <i>Application Load Balancer Guide</i> or <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-limits.html\">Limits for Your Network Load Balancers</a> in the <i>Network Load Balancers Guide</i>.</p>",
"DescribeListeners": "<p>Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.</p>",
"DescribeLoadBalancerAttributes": "<p>Describes the attributes for the specified Application Load Balancer or Network Load Balancer.</p>",
"DescribeLoadBalancers": "<p>Describes the specified load balancers or all of your load balancers.</p> <p>To describe the listeners for a load balancer, use <a>DescribeListeners</a>. To describe the attributes for a load balancer, use <a>DescribeLoadBalancerAttributes</a>.</p>",
"DescribeRules": "<p>Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.</p>",
"DescribeSSLPolicies": "<p>Describes the specified policies or all policies used for SSL negotiation.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i>.</p>",
"DescribeTags": "<p>Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers and target groups.</p>",
"DescribeTags": "<p>Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.</p>",
"DescribeTargetGroupAttributes": "<p>Describes the attributes for the specified target group.</p>",
"DescribeTargetGroups": "<p>Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.</p> <p>To describe the targets for a target group, use <a>DescribeTargetHealth</a>. To describe the attributes of a target group, use <a>DescribeTargetGroupAttributes</a>.</p>",
"DescribeTargetHealth": "<p>Describes the health of the specified targets or all of your targets.</p>",
"ModifyListener": "<p>Modifies the specified properties of the specified listener.</p> <p>Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.</p>",
"ModifyLoadBalancerAttributes": "<p>Modifies the specified attributes of the specified Application Load Balancer.</p> <p>If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.</p>",
"ModifyLoadBalancerAttributes": "<p>Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.</p> <p>If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.</p>",
"ModifyRule": "<p>Modifies the specified rule.</p> <p>Any existing properties that you do not modify retain their current values.</p> <p>To modify the default action, use <a>ModifyListener</a>.</p>",
"ModifyTargetGroup": "<p>Modifies the health checks used when evaluating the health state of the targets in the specified target group.</p> <p>To monitor the health of the targets, use <a>DescribeTargetHealth</a>.</p>",
"ModifyTargetGroupAttributes": "<p>Modifies the specified attributes of the specified target group.</p>",
"RegisterTargets": "<p>Registers the specified targets with the specified target group.</p> <p>By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.</p> <p>The target must be in the virtual private cloud (VPC) that you specified for the target group. If the target is an EC2 instance, it must be in the <code>running</code> state when you register it.</p> <p>To remove a target from a target group, use <a>DeregisterTargets</a>.</p>",
"RemoveTags": "<p>Removes the specified tags from the specified resource.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>.</p>",
"SetIpAddressType": "<p>Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.</p>",
"RegisterTargets": "<p>Registers the specified targets with the specified target group.</p> <p>By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.</p> <p>The target must be in the virtual private cloud (VPC) that you specified for the target group. If the target is an EC2 instance, it must be in the <code>running</code> state when you register it.</p> <p>Network Load Balancers do not support the following instance types as targets: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.</p> <p>To remove a target from a target group, use <a>DeregisterTargets</a>.</p>",
"RemoveTags": "<p>Removes the specified tags from the specified Elastic Load Balancing resource.</p> <p>To list the current tags for your resources, use <a>DescribeTags</a>.</p>",
"SetIpAddressType": "<p>Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.</p> <p>Note that Network Load Balancers must use <code>ipv4</code>.</p>",
"SetRulePriorities": "<p>Sets the priorities of the specified rules.</p> <p>You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.</p>",
"SetSecurityGroups": "<p>Associates the specified security groups with the specified load balancer. The specified security groups override the previously associated security groups.</p>",
"SetSubnets": "<p>Enables the Availability Zone for the specified subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.</p>"
"SetSecurityGroups": "<p>Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.</p> <p>Note that you can't specify a security group for a Network Load Balancer.</p>",
"SetSubnets": "<p>Enables the Availability Zone for the specified subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.</p> <p>Note that you can't change the subnets for a Network Load Balancer.</p>"
},
"shapes": {
"Action": {
@@ -50,11 +50,11 @@
"Actions": {
"base": null,
"refs": {
"CreateListenerInput$DefaultActions": "<p>The default action for the listener.</p>",
"CreateListenerInput$DefaultActions": "<p>The default action for the listener. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.</p>",
"CreateRuleInput$Actions": "<p>An action. Each action has the type <code>forward</code> and specifies a target group.</p>",
"Listener$DefaultActions": "<p>The default actions for the listener.</p>",
"ModifyListenerInput$DefaultActions": "<p>The default actions.</p>",
"ModifyRuleInput$Actions": "<p>The actions.</p>",
"ModifyListenerInput$DefaultActions": "<p>The default action. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.</p>",
"ModifyRuleInput$Actions": "<p>The actions. The target group must use the HTTP or HTTPS protocol.</p>",
"Rule$Actions": "<p>The actions.</p>"
}
},
@@ -68,12 +68,29 @@
"refs": {
}
},
"AllocationId": {
"base": null,
"refs": {
"LoadBalancerAddress$AllocationId": "<p>[Network Load Balancers] The allocation ID of the Elastic IP address.</p>",
"SubnetMapping$AllocationId": "<p>[Network Load Balancers] The allocation ID of the Elastic IP address.</p>"
}
},
"AllocationIdNotFoundException": {
"base": "<p>The specified allocation ID does not exist.</p>",
"refs": {
}
},
"AvailabilityZone": {
"base": "<p>Information about an Availability Zone.</p>",
"refs": {
"AvailabilityZones$member": null
}
},
"AvailabilityZoneNotSupportedException": {
"base": "<p>The specified Availability Zone is not supported.</p>",
"refs": {
}
},
"AvailabilityZones": {
"base": null,
"refs": {
@@ -102,7 +119,7 @@
"CertificateList": {
"base": null,
"refs": {
"CreateListenerInput$Certificates": "<p>The SSL server certificate. You must provide exactly one certificate if the protocol is HTTPS.</p>",
"CreateListenerInput$Certificates": "<p>[HTTPS listeners] The SSL server certificate. You must provide exactly one certificate.</p>",
"Listener$Certificates": "<p>The SSL server certificate. You must provide a certificate if the protocol is HTTPS.</p>",
"ModifyListenerInput$Certificates": "<p>The SSL server certificate.</p>"
}
@@ -373,16 +390,16 @@
"HealthCheckIntervalSeconds": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target. The default is 30 seconds.</p>",
"ModifyTargetGroupInput$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target.</p>",
"CreateTargetGroupInput$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds. The default is 30 seconds.</p>",
"ModifyTargetGroupInput$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.</p>",
"TargetGroup$HealthCheckIntervalSeconds": "<p>The approximate amount of time, in seconds, between health checks of an individual target.</p>"
}
},
"HealthCheckPort": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckPort": "<p>The port the load balancer uses when performing health checks on targets. The default is <code>traffic-port</code>, which indicates the port on which each target receives traffic from the load balancer.</p>",
"ModifyTargetGroupInput$HealthCheckPort": "<p>The port to use to connect with the target.</p>",
"CreateTargetGroupInput$HealthCheckPort": "<p>The port the load balancer uses when performing health checks on targets. The default is <code>traffic-port</code>, which is the port on which each target receives traffic from the load balancer.</p>",
"ModifyTargetGroupInput$HealthCheckPort": "<p>The port the load balancer uses when performing health checks on targets.</p>",
"TargetGroup$HealthCheckPort": "<p>The port to use to connect with the target.</p>",
"TargetHealthDescription$HealthCheckPort": "<p>The port to use to connect with the target.</p>"
}
@@ -390,10 +407,10 @@
"HealthCheckThresholdCount": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthyThresholdCount": "<p>The number of consecutive health checks successes required before considering an unhealthy target healthy. The default is 5.</p>",
"CreateTargetGroupInput$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering a target unhealthy. The default is 2.</p>",
"CreateTargetGroupInput$HealthyThresholdCount": "<p>The number of consecutive health checks successes required before considering an unhealthy target healthy. For Application Load Balancers, the default is 5. For Network Load Balancers, the default is 3.</p>",
"CreateTargetGroupInput$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering a target unhealthy. For Application Load Balancers, the default is 2. For Network Load Balancers, this value must be the same as the healthy threshold count.</p>",
"ModifyTargetGroupInput$HealthyThresholdCount": "<p>The number of consecutive health checks successes required before considering an unhealthy target healthy.</p>",
"ModifyTargetGroupInput$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering the target unhealthy.</p>",
"ModifyTargetGroupInput$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count.</p>",
"TargetGroup$HealthyThresholdCount": "<p>The number of consecutive health checks successes required before considering an unhealthy target healthy.</p>",
"TargetGroup$UnhealthyThresholdCount": "<p>The number of consecutive health check failures required before considering the target unhealthy.</p>"
}
@@ -401,8 +418,8 @@
"HealthCheckTimeoutSeconds": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckTimeoutSeconds": "<p>The amount of time, in seconds, during which no response from a target means a failed health check. The default is 5 seconds.</p>",
"ModifyTargetGroupInput$HealthCheckTimeoutSeconds": "<p>The amount of time, in seconds, during which no response means a failed health check.</p>",
"CreateTargetGroupInput$HealthCheckTimeoutSeconds": "<p>The amount of time, in seconds, during which no response from a target means a failed health check. For Application Load Balancers, the range is 2 to 60 seconds and the default is 5 seconds. For Network Load Balancers, this is 10 seconds for TCP and HTTPS health checks and 6 seconds for HTTP health checks.</p>",
"ModifyTargetGroupInput$HealthCheckTimeoutSeconds": "<p>[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.</p>",
"TargetGroup$HealthCheckTimeoutSeconds": "<p>The amount of time, in seconds, during which no response means a failed health check.</p>"
}
},
@@ -414,7 +431,7 @@
"HttpCode": {
"base": null,
"refs": {
"Matcher$HttpCode": "<p>The HTTP codes. You can specify values between 200 and 499. The default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").</p>"
"Matcher$HttpCode": "<p>The HTTP codes.</p> <p>For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").</p> <p>For Network Load Balancers, this is 200 to 399.</p>"
}
},
"IncompatibleProtocolsException": {
@@ -447,10 +464,16 @@
"refs": {
}
},
"IpAddress": {
"base": null,
"refs": {
"LoadBalancerAddress$IpAddress": "<p>The static IP address.</p>"
}
},
"IpAddressType": {
"base": null,
"refs": {
"CreateLoadBalancerInput$IpAddressType": "<p>The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses). Internal load balancers must use <code>ipv4</code>.</p>",
"CreateLoadBalancerInput$IpAddressType": "<p>[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses). Internal load balancers must use <code>ipv4</code>.</p>",
"LoadBalancer$IpAddressType": "<p>The type of IP addresses used by the subnets for your load balancer. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses).</p>",
"SetIpAddressTypeInput$IpAddressType": "<p>The IP address type. The possible values are <code>ipv4</code> (for IPv4 addresses) and <code>dualstack</code> (for IPv4 and IPv6 addresses). Internal load balancers must use <code>ipv4</code>.</p>",
"SetIpAddressTypeOutput$IpAddressType": "<p>The IP address type.</p>"
@@ -522,6 +545,18 @@
"LoadBalancers$member": null
}
},
"LoadBalancerAddress": {
"base": "<p>Information about a static IP address for a load balancer.</p>",
"refs": {
"LoadBalancerAddresses$member": null
}
},
"LoadBalancerAddresses": {
"base": null,
"refs": {
"AvailabilityZone$LoadBalancerAddresses": "<p>[Network Load Balancers] The static IP address.</p>"
}
},
"LoadBalancerArn": {
"base": null,
"refs": {
@@ -555,7 +590,7 @@
"LoadBalancerAttributeKey": {
"base": null,
"refs": {
"LoadBalancerAttribute$Key": "<p>The name of the attribute.</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - Indicates whether access logs stored in Amazon S3 are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - The prefix for the location in the S3 bucket. If you don't specify a prefix, the access logs are stored in the root of the bucket.</p> </li> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - The idle timeout value, in seconds. The valid range is 1-3600. The default is 60 seconds.</p> </li> </ul>"
"LoadBalancerAttribute$Key": "<p>The name of the attribute.</p> <ul> <li> <p> <code>access_logs.s3.enabled</code> - [Application Load Balancers] Indicates whether access logs stored in Amazon S3 are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>access_logs.s3.bucket</code> - [Application Load Balancers] The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.</p> </li> <li> <p> <code>access_logs.s3.prefix</code> - [Application Load Balancers] The prefix for the location in the S3 bucket. If you don't specify a prefix, the access logs are stored in the root of the bucket.</p> </li> <li> <p> <code>deletion_protection.enabled</code> - Indicates whether deletion protection is enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>idle_timeout.timeout_seconds</code> - [Application Load Balancers] The idle timeout value, in seconds. The valid range is 1-4000. The default is 60 seconds.</p> </li> </ul>"
}
},
"LoadBalancerAttributeValue": {
@@ -613,6 +648,7 @@
"LoadBalancerTypeEnum": {
"base": null,
"refs": {
"CreateLoadBalancerInput$Type": "<p>The type of load balancer to create. The default is <code>application</code>.</p>",
"LoadBalancer$Type": "<p>The type of load balancer.</p>"
}
},
@@ -643,8 +679,8 @@
"Matcher": {
"base": "<p>Information to use when checking for a successful response from a target.</p>",
"refs": {
"CreateTargetGroupInput$Matcher": "<p>The HTTP codes to use when checking for a successful response from a target. The default is 200.</p>",
"ModifyTargetGroupInput$Matcher": "<p>The HTTP codes to use when checking for a successful response from a target.</p>",
"CreateTargetGroupInput$Matcher": "<p>[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.</p>",
"ModifyTargetGroupInput$Matcher": "<p>[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.</p>",
"TargetGroup$Matcher": "<p>The HTTP codes to use when checking for a successful response from a target.</p>"
}
},
@@ -707,7 +743,7 @@
"Name": {
"base": null,
"refs": {
"Limit$Name": "<p>The name of the limit. The possible values are:</p> <ul> <li> <p>application-load-balancers</p> </li> <li> <p>listeners-per-application-load-balancer</p> </li> <li> <p>rules-per-application-load-balancer</p> </li> <li> <p>target-groups</p> </li> <li> <p>targets-per-application-load-balancer</p> </li> </ul>"
"Limit$Name": "<p>The name of the limit. The possible values are:</p> <ul> <li> <p>application-load-balancers</p> </li> <li> <p>listeners-per-application-load-balancer</p> </li> <li> <p>listeners-per-network-load-balancer</p> </li> <li> <p>network-load-balancers</p> </li> <li> <p>rules-per-application-load-balancer</p> </li> <li> <p>target-groups</p> </li> <li> <p>targets-per-application-load-balancer</p> </li> </ul>"
}
},
"OperationNotPermittedException": {
@@ -729,8 +765,8 @@
"Path": {
"base": null,
"refs": {
"CreateTargetGroupInput$HealthCheckPath": "<p>The ping path that is the destination on the targets for health checks. The default is /.</p>",
"ModifyTargetGroupInput$HealthCheckPath": "<p>The ping path that is the destination for the health check request.</p>",
"CreateTargetGroupInput$HealthCheckPath": "<p>[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.</p>",
"ModifyTargetGroupInput$HealthCheckPath": "<p>[HTTP/HTTPS health checks] The ping path that is the destination for the health check request.</p>",
"TargetGroup$HealthCheckPath": "<p>The destination for the health check request.</p>"
}
},
@@ -753,12 +789,12 @@
"ProtocolEnum": {
"base": null,
"refs": {
"CreateListenerInput$Protocol": "<p>The protocol for connections from clients to the load balancer.</p>",
"CreateTargetGroupInput$Protocol": "<p>The protocol to use for routing traffic to the targets.</p>",
"CreateTargetGroupInput$HealthCheckProtocol": "<p>The protocol the load balancer uses when performing health checks on targets. The default is the HTTP protocol.</p>",
"CreateListenerInput$Protocol": "<p>The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.</p>",
"CreateTargetGroupInput$Protocol": "<p>The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.</p>",
"CreateTargetGroupInput$HealthCheckProtocol": "<p>The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.</p>",
"Listener$Protocol": "<p>The protocol for connections from clients to the load balancer.</p>",
"ModifyListenerInput$Protocol": "<p>The protocol for connections from clients to the load balancer.</p>",
"ModifyTargetGroupInput$HealthCheckProtocol": "<p>The protocol to use to connect with the target.</p>",
"ModifyListenerInput$Protocol": "<p>The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.</p>",
"ModifyTargetGroupInput$HealthCheckProtocol": "<p>The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported only if the protocol of the target group is TCP.</p>",
"TargetGroup$Protocol": "<p>The protocol to use for routing traffic to the targets.</p>",
"TargetGroup$HealthCheckProtocol": "<p>The protocol to use to connect with the target.</p>"
}
@@ -834,7 +870,7 @@
"RuleConditionList": {
"base": null,
"refs": {
"CreateRuleInput$Conditions": "<p>A condition. Each condition specifies a field name and a single value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>",
"CreateRuleInput$Conditions": "<p>The conditions. Each condition specifies a field name and a single value.</p> <p>If the field name is <code>host-header</code>, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>- .</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul> <p>If the field name is <code>path-pattern</code>, you can specify a single path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters.</p> <ul> <li> <p>A-Z, a-z, 0-9</p> </li> <li> <p>_ - . $ / ~ \" ' @ : +</p> </li> <li> <p>&amp; (using &amp;amp;)</p> </li> <li> <p>* (matches 0 or more characters)</p> </li> <li> <p>? (matches exactly 1 character)</p> </li> </ul>",
"ModifyRuleInput$Conditions": "<p>The conditions.</p>",
"Rule$Conditions": "<p>The conditions.</p>"
}
@@ -886,7 +922,7 @@
"SecurityGroups": {
"base": null,
"refs": {
"CreateLoadBalancerInput$SecurityGroups": "<p>The IDs of the security groups to assign to the load balancer.</p>",
"CreateLoadBalancerInput$SecurityGroups": "<p>[Application Load Balancers] The IDs of the security groups to assign to the load balancer.</p>",
"LoadBalancer$SecurityGroups": "<p>The IDs of the security groups for the load balancer.</p>",
"SetSecurityGroupsInput$SecurityGroups": "<p>The IDs of the security groups.</p>",
"SetSecurityGroupsOutput$SecurityGroupIds": "<p>The IDs of the security groups associated with the load balancer.</p>"
@@ -947,7 +983,7 @@
"SslPolicyName": {
"base": null,
"refs": {
"CreateListenerInput$SslPolicy": "<p>The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>",
"CreateListenerInput$SslPolicy": "<p>[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>",
"Listener$SslPolicy": "<p>The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.</p>",
"ModifyListenerInput$SslPolicy": "<p>The security policy that defines which protocols and ciphers are supported. For more information, see <a href=\"http://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies\">Security Policies</a> in the <i>Application Load Balancers Guide</i>.</p>",
"SslPolicy$Name": "<p>The name of the policy.</p>",
@@ -994,9 +1030,23 @@
"base": null,
"refs": {
"AvailabilityZone$SubnetId": "<p>The ID of the subnet.</p>",
"SubnetMapping$SubnetId": "<p>The ID of the subnet.</p>",
"Subnets$member": null
}
},
"SubnetMapping": {
"base": "<p>Information about a subnet mapping.</p>",
"refs": {
"SubnetMappings$member": null
}
},
"SubnetMappings": {
"base": null,
"refs": {
"CreateLoadBalancerInput$SubnetMappings": "<p>The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.</p> <p>[Network Load Balancers] You can specify one Elastic IP address per subnet.</p> <p>[Application Load Balancers] You cannot specify Elastic IP addresses for your subnets.</p>",
"SetSubnetsInput$SubnetMappings": "<p>The IDs of the subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.</p> <p>The load balancer is allocated one static IP address per subnet. You cannot specify your own Elastic IP addresses.</p>"
}
},
"SubnetNotFoundException": {
"base": "<p>The specified subnet does not exist.</p>",
"refs": {
@@ -1005,8 +1055,8 @@
"Subnets": {
"base": null,
"refs": {
"CreateLoadBalancerInput$Subnets": "<p>The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones.</p>",
"SetSubnetsInput$Subnets": "<p>The IDs of the subnets. You must specify at least two subnets. You can add only one subnet per Availability Zone.</p>"
"CreateLoadBalancerInput$Subnets": "<p>The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.</p> <p>[Application Load Balancers] You must specify subnets from at least two Availability Zones.</p>",
"SetSubnetsInput$Subnets": "<p>The IDs of the subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.</p>"
}
},
"Tag": {
@@ -1110,7 +1160,7 @@
"TargetGroupAttributeKey": {
"base": null,
"refs": {
"TargetGroupAttribute$Key": "<p>The name of the attribute.</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds.</p> </li> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible value is <code>lb_cookie</code>.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul>"
"TargetGroupAttribute$Key": "<p>The name of the attribute.</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds.</p> </li> <li> <p> <code>stickiness.enabled</code> - [Application Load Balancers] Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - [Application Load Balancers] The type of sticky sessions. The possible value is <code>lb_cookie</code>.</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - [Application Load Balancers] The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul>"
}
},
"TargetGroupAttributeValue": {
@@ -1175,7 +1225,7 @@
"TargetHealthReasonEnum": {
"base": null,
"refs": {
"TargetHealth$Reason": "<p>The reason code. If the target state is <code>healthy</code>, a reason code is not provided.</p> <p>If the target state is <code>initial</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Elb.RegistrationInProgress</code> - The target is in the process of being registered with the load balancer.</p> </li> <li> <p> <code>Elb.InitialHealthChecking</code> - The load balancer is still sending the target the minimum number of health checks required to determine its health status.</p> </li> </ul> <p>If the target state is <code>unhealthy</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.ResponseCodeMismatch</code> - The health checks did not return an expected HTTP code.</p> </li> <li> <p> <code>Target.Timeout</code> - The health check requests timed out.</p> </li> <li> <p> <code>Target.FailedHealthChecks</code> - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.</p> </li> <li> <p> <code>Elb.InternalError</code> - The health checks failed due to an internal error.</p> </li> </ul> <p>If the target state is <code>unused</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.NotRegistered</code> - The target is not registered with the target group.</p> </li> <li> <p> <code>Target.NotInUse</code> - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.</p> </li> <li> <p> <code>Target.InvalidState</code> - The target is in the stopped or terminated state.</p> </li> </ul> <p>If the target state is <code>draining</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.DeregistrationInProgress</code> - The target is in the process of being deregistered and the deregistration delay period has not expired.</p> </li> </ul>"
"TargetHealth$Reason": "<p>The reason code. If the target state is <code>healthy</code>, a reason code is not provided.</p> <p>If the target state is <code>initial</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Elb.RegistrationInProgress</code> - The target is in the process of being registered with the load balancer.</p> </li> <li> <p> <code>Elb.InitialHealthChecking</code> - The load balancer is still sending the target the minimum number of health checks required to determine its health status.</p> </li> </ul> <p>If the target state is <code>unhealthy</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.ResponseCodeMismatch</code> - The health checks did not return an expected HTTP code.</p> </li> <li> <p> <code>Target.Timeout</code> - The health check requests timed out.</p> </li> <li> <p> <code>Target.FailedHealthChecks</code> - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.</p> </li> <li> <p> <code>Elb.InternalError</code> - The health checks failed due to an internal error.</p> </li> </ul> <p>If the target state is <code>unused</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.NotRegistered</code> - The target is not registered with the target group.</p> </li> <li> <p> <code>Target.NotInUse</code> - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.</p> </li> <li> <p> <code>Target.IpUnusable</code> - The target IP address is reserved for use by a load balancer.</p> </li> <li> <p> <code>Target.InvalidState</code> - The target is in the stopped or terminated state.</p> </li> </ul> <p>If the target state is <code>draining</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.DeregistrationInProgress</code> - The target is in the process of being deregistered and the deregistration delay period has not expired.</p> </li> </ul>"
}
},
"TargetHealthStateEnum": {
@@ -1187,7 +1237,14 @@
"TargetId": {
"base": null,
"refs": {
"TargetDescription$Id": "<p>The ID of the target.</p>"
"TargetDescription$Id": "<p>The ID of the target. If the target type of the target group is <code>instance</code>, specify an instance ID. If the target type is <code>ip</code>, specify an IP address.</p>"
}
},
"TargetTypeEnum": {
"base": null,
"refs": {
"CreateTargetGroupInput$TargetType": "<p>The type of target that you must specify when registering targets with this target group. The possible values are <code>instance</code> (targets are specified by instance ID) or <code>ip</code> (targets are specified by IP address). The default is <code>instance</code>. Note that you can't specify targets for a target group using both instance IDs and IP addresses.</p> <p>If the target type is <code>ip</code>, specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.</p>",
"TargetGroup$TargetType": "<p>The type of target that you must specify when registering targets with this target group. The possible values are <code>instance</code> (targets are specified by instance ID) or <code>ip</code> (targets are specified by IP address).</p>"
}
},
"TooManyCertificatesException": {
@@ -1246,7 +1303,8 @@
"ZoneName": {
"base": null,
"refs": {
"AvailabilityZone$ZoneName": "<p>The name of the Availability Zone.</p>"
"AvailabilityZone$ZoneName": "<p>The name of the Availability Zone.</p>",
"TargetDescription$AvailabilityZone": "<p>The Availability Zone where the IP address is to be registered. Specify <code>all</code> to register an IP address outside the target group VPC with all Availability Zones that are enabled for the load balancer.</p> <p>If the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional.</p> <p>This parameter is not supported if the target type of the target group is <code>instance</code>.</p>"
}
}
}

36
vendor/github.com/aws/aws-sdk-go/models/apis/elasticloadbalancingv2/2015-12-01/waiters-2.json generated vendored
View File

@@ -59,6 +59,42 @@
"state": "success"
}
]
},
"TargetInService":{
"delay":15,
"maxAttempts":40,
"operation":"DescribeTargetHealth",
"acceptors":[
{
"argument":"TargetHealthDescriptions[].TargetHealth.State",
"expected":"healthy",
"matcher":"pathAll",
"state":"success"
},
{
"matcher": "error",
"expected": "InvalidInstance",
"state": "retry"
}
]
},
"TargetDeregistered": {
"delay": 15,
"maxAttempts": 40,
"operation": "DescribeTargetHealth",
"acceptors": [
{
"matcher": "error",
"expected": "InvalidTarget",
"state": "success"
},
{
"argument":"TargetHealthDescriptions[].TargetHealth.State",
"expected":"unused",
"matcher":"pathAll",
"state":"success"
}
]
}
}
}

180
vendor/github.com/aws/aws-sdk-go/models/apis/email/2010-12-01/api-2.json generated vendored
View File

@@ -1,7 +1,6 @@
{
"version":"2.0",
"metadata":{
"uid":"email-2010-12-01",
"apiVersion":"2010-12-01",
"endpointPrefix":"email",
"protocol":"query",
@@ -9,6 +8,7 @@
"serviceFullName":"Amazon Simple Email Service",
"signatureVersion":"v4",
"signingName":"ses",
"uid":"email-2010-12-01",
"xmlNamespace":"http://ses.amazonaws.com/doc/2010-12-01/"
},
"operations":{
@@ -62,9 +62,27 @@
{"shape":"EventDestinationAlreadyExistsException"},
{"shape":"InvalidCloudWatchDestinationException"},
{"shape":"InvalidFirehoseDestinationException"},
{"shape":"InvalidSNSDestinationException"},
{"shape":"LimitExceededException"}
]
},
"CreateConfigurationSetTrackingOptions":{
"name":"CreateConfigurationSetTrackingOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConfigurationSetTrackingOptionsRequest"},
"output":{
"shape":"CreateConfigurationSetTrackingOptionsResponse",
"resultWrapper":"CreateConfigurationSetTrackingOptionsResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"TrackingOptionsAlreadyExistsException"},
{"shape":"InvalidTrackingOptionsException"}
]
},
"CreateReceiptFilter":{
"name":"CreateReceiptFilter",
"http":{
@@ -149,6 +167,22 @@
{"shape":"EventDestinationDoesNotExistException"}
]
},
"DeleteConfigurationSetTrackingOptions":{
"name":"DeleteConfigurationSetTrackingOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConfigurationSetTrackingOptionsRequest"},
"output":{
"shape":"DeleteConfigurationSetTrackingOptionsResponse",
"resultWrapper":"DeleteConfigurationSetTrackingOptionsResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"TrackingOptionsDoesNotExistException"}
]
},
"DeleteIdentity":{
"name":"DeleteIdentity",
"http":{
@@ -620,7 +654,25 @@
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"EventDestinationDoesNotExistException"},
{"shape":"InvalidCloudWatchDestinationException"},
{"shape":"InvalidFirehoseDestinationException"}
{"shape":"InvalidFirehoseDestinationException"},
{"shape":"InvalidSNSDestinationException"}
]
},
"UpdateConfigurationSetTrackingOptions":{
"name":"UpdateConfigurationSetTrackingOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateConfigurationSetTrackingOptionsRequest"},
"output":{
"shape":"UpdateConfigurationSetTrackingOptionsResponse",
"resultWrapper":"UpdateConfigurationSetTrackingOptionsResult"
},
"errors":[
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"TrackingOptionsDoesNotExistException"},
{"shape":"InvalidTrackingOptionsException"}
]
},
"UpdateReceiptRule":{
@@ -851,7 +903,10 @@
},
"ConfigurationSetAttribute":{
"type":"string",
"enum":["eventDestinations"]
"enum":[
"eventDestinations",
"trackingOptions"
]
},
"ConfigurationSetAttributeList":{
"type":"list",
@@ -911,6 +966,22 @@
"members":{
}
},
"CreateConfigurationSetTrackingOptionsRequest":{
"type":"structure",
"required":[
"ConfigurationSetName",
"TrackingOptions"
],
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"},
"TrackingOptions":{"shape":"TrackingOptions"}
}
},
"CreateConfigurationSetTrackingOptionsResponse":{
"type":"structure",
"members":{
}
},
"CreateReceiptFilterRequest":{
"type":"structure",
"required":["Filter"],
@@ -961,6 +1032,7 @@
"TemporaryFailure"
]
},
"CustomRedirectDomain":{"type":"string"},
"DefaultDimensionValue":{"type":"string"},
"DeleteConfigurationSetEventDestinationRequest":{
"type":"structure",
@@ -990,6 +1062,18 @@
"members":{
}
},
"DeleteConfigurationSetTrackingOptionsRequest":{
"type":"structure",
"required":["ConfigurationSetName"],
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"}
}
},
"DeleteConfigurationSetTrackingOptionsResponse":{
"type":"structure",
"members":{
}
},
"DeleteIdentityPolicyRequest":{
"type":"structure",
"required":[
@@ -1089,7 +1173,8 @@
"type":"structure",
"members":{
"ConfigurationSet":{"shape":"ConfigurationSet"},
"EventDestinations":{"shape":"EventDestinations"}
"EventDestinations":{"shape":"EventDestinations"},
"TrackingOptions":{"shape":"TrackingOptions"}
}
},
"DescribeReceiptRuleRequest":{
@@ -1137,7 +1222,8 @@
"type":"string",
"enum":[
"messageTag",
"emailHeader"
"emailHeader",
"linkTag"
]
},
"DkimAttributes":{
@@ -1169,7 +1255,8 @@
"Enabled":{"shape":"Enabled"},
"MatchingEventTypes":{"shape":"EventTypes"},
"KinesisFirehoseDestination":{"shape":"KinesisFirehoseDestination"},
"CloudWatchDestination":{"shape":"CloudWatchDestination"}
"CloudWatchDestination":{"shape":"CloudWatchDestination"},
"SNSDestination":{"shape":"SNSDestination"}
}
},
"EventDestinationAlreadyExistsException":{
@@ -1210,7 +1297,9 @@
"reject",
"bounce",
"complaint",
"delivery"
"delivery",
"open",
"click"
]
},
"EventTypes":{
@@ -1460,6 +1549,19 @@
},
"exception":true
},
"InvalidSNSDestinationException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"},
"EventDestinationName":{"shape":"EventDestinationName"}
},
"error":{
"code":"InvalidSNSDestination",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidSnsTopicException":{
"type":"structure",
"members":{
@@ -1472,6 +1574,17 @@
},
"exception":true
},
"InvalidTrackingOptionsException":{
"type":"structure",
"members":{
},
"error":{
"code":"InvalidTrackingOptions",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvocationType":{
"type":"string",
"enum":[
@@ -1888,6 +2001,13 @@
"Base64"
]
},
"SNSDestination":{
"type":"structure",
"required":["TopicARN"],
"members":{
"TopicARN":{"shape":"AmazonResourceName"}
}
},
"SendBounceRequest":{
"type":"structure",
"required":[
@@ -2101,6 +2221,36 @@
"Optional"
]
},
"TrackingOptions":{
"type":"structure",
"members":{
"CustomRedirectDomain":{"shape":"CustomRedirectDomain"}
}
},
"TrackingOptionsAlreadyExistsException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"}
},
"error":{
"code":"TrackingOptionsAlreadyExistsException",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"TrackingOptionsDoesNotExistException":{
"type":"structure",
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"}
},
"error":{
"code":"TrackingOptionsDoesNotExistException",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"UpdateConfigurationSetEventDestinationRequest":{
"type":"structure",
"required":[
@@ -2117,6 +2267,22 @@
"members":{
}
},
"UpdateConfigurationSetTrackingOptionsRequest":{
"type":"structure",
"required":[
"ConfigurationSetName",
"TrackingOptions"
],
"members":{
"ConfigurationSetName":{"shape":"ConfigurationSetName"},
"TrackingOptions":{"shape":"TrackingOptions"}
}
},
"UpdateConfigurationSetTrackingOptionsResponse":{
"type":"structure",
"members":{
}
},
"UpdateReceiptRuleRequest":{
"type":"structure",
"required":[

279
vendor/github.com/aws/aws-sdk-go/models/apis/email/2010-12-01/docs-2.json generated vendored
View File

@@ -1,56 +1,59 @@
{
"version": "2.0",
"service": "<fullname>Amazon Simple Email Service</fullname> <p> This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>. </p> <note> <p> For a list of Amazon SES endpoints to use in service requests, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html\">Regions and Amazon SES</a> in the Amazon SES Developer Guide. </p> </note>",
"service": "<fullname>Amazon Simple Email Service</fullname> <p> This is the API Reference for <a href=\"https://aws.amazon.com/ses/\">Amazon Simple Email Service</a> (Amazon SES). This documentation is intended to be used in conjunction with the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</i> </p> <note> <p> For a list of Amazon SES endpoints to use in service requests, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html\">Regions and Amazon SES</a> in the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</i> </p> </note>",
"operations": {
"CloneReceiptRuleSet": "<p>Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.</p> <p>For information about setting up rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"CreateConfigurationSet": "<p>Creates a configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"CreateConfigurationSetEventDestination": "<p>Creates a configuration set event destination.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.</p> </note> <p>An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"CreateReceiptFilter": "<p>Creates a new IP address filter.</p> <p>For information about setting up IP address filters, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"CreateReceiptRule": "<p>Creates a receipt rule.</p> <p>For information about setting up receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"CreateReceiptRuleSet": "<p>Creates an empty receipt rule set.</p> <p>For information about setting up receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DeleteConfigurationSet": "<p>Deletes a configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DeleteConfigurationSetEventDestination": "<p>Deletes a configuration set event destination.</p> <p>Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DeleteIdentity": "<p>Deletes the specified identity (an email address or a domain) from the list of verified identities.</p> <p>This action is throttled at one request per second.</p>",
"DeleteIdentityPolicy": "<p>Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DeleteReceiptFilter": "<p>Deletes the specified IP address filter.</p> <p>For information about managing IP address filters, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DeleteReceiptRule": "<p>Deletes the specified receipt rule.</p> <p>For information about managing receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DeleteReceiptRuleSet": "<p>Deletes the specified receipt rule set and all of the receipt rules it contains.</p> <note> <p>The currently active rule set cannot be deleted.</p> </note> <p>For information about managing receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DeleteVerifiedEmailAddress": "<p>Deletes the specified email address from the list of verified addresses.</p> <important> <p>The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.</p> </important> <p>This action is throttled at one request per second.</p>",
"DescribeActiveReceiptRuleSet": "<p>Returns the metadata and receipt rules for the receipt rule set that is currently active.</p> <p>For information about setting up receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DescribeConfigurationSet": "<p>Returns the details of the specified configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DescribeReceiptRule": "<p>Returns the details of the specified receipt rule.</p> <p>For information about setting up receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"DescribeReceiptRuleSet": "<p>Returns the details of the specified receipt rule set.</p> <p>For information about managing receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"GetIdentityDkimAttributes": "<p>Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.</p> <p>This action takes a list of identities as input and returns the following information for each:</p> <ul> <li> <p>Whether Easy DKIM signing is enabled or disabled.</p> </li> <li> <p>A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.</p> </li> <li> <p>Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.</p> </li> </ul> <p>This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.</p> <p>For more information about creating DNS records using DKIM tokens, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html\">Amazon SES Developer Guide</a>.</p>",
"GetIdentityMailFromDomainAttributes": "<p>Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).</p> <p>This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.</p>",
"GetIdentityNotificationAttributes": "<p>Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.</p> <p>This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.</p> <p>For more information about using notifications with Amazon SES, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</p>",
"GetIdentityPolicies": "<p>Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"GetIdentityVerificationAttributes": "<p>Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.</p> <p>This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.</p>",
"GetSendQuota": "<p>Returns the user's current sending limits.</p> <p>This action is throttled at one request per second.</p>",
"GetSendStatistics": "<p>Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity.</p> <p>Each data point in the list contains statistics for a 15-minute interval.</p> <p>This action is throttled at one request per second.</p>",
"ListConfigurationSets": "<p>Lists the configuration sets associated with your AWS account.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second and can return up to 50 configuration sets at a time.</p>",
"ListIdentities": "<p>Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.</p> <p>This action is throttled at one request per second.</p>",
"ListIdentityPolicies": "<p>Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use <code>GetIdentityPolicies</code>.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"ListReceiptFilters": "<p>Lists the IP address filters associated with your AWS account.</p> <p>For information about managing IP address filters, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"ListReceiptRuleSets": "<p>Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a <code>NextToken</code> that you can provide to the next call to <code>ListReceiptRuleSets</code> to retrieve the additional entries.</p> <p>For information about managing receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"ListVerifiedEmailAddresses": "<p>Returns a list containing all of the email addresses that have been verified.</p> <important> <p>The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.</p> </important> <p>This action is throttled at one request per second.</p>",
"PutIdentityPolicy": "<p>Adds or updates a sending authorization policy for the specified identity (an email address or a domain).</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"ReorderReceiptRuleSet": "<p>Reorders the receipt rules within a receipt rule set.</p> <note> <p>All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.</p> </note> <p>For information about managing receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"SendBounce": "<p>Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.</p> <note> <p>You cannot use this API to send generic bounces for mail that was not received by Amazon SES.</p> </note> <p>For information about receiving email through Amazon SES, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"SendEmail": "<p>Composes an email message based on input data, and then immediately queues the message for sending.</p> <p>There are several important points to know about <code>SendEmail</code>:</p> <ul> <li> <p>You can only send email from verified email addresses and domains; otherwise, you will get an \"Email address not verified\" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</p> </li> <li> <p>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</p> </li> <li> <p>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Amazon SES Developer Guide</a>.</p> </li> </ul>",
"SendRawEmail": "<p>Sends an email message, with header and content specified by the client. The <code>SendRawEmail</code> action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent. </p> <p>There are several important points to know about <code>SendRawEmail</code>:</p> <ul> <li> <p>You can only send email from verified email addresses and domains; otherwise, you will get an \"Email address not verified\" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.</p> </li> <li> <p>Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.</p> </li> <li> <p>The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.</p> </li> <li> <p>Amazon SES overrides any Message-ID and Date headers you provide.</p> </li> <li> <p>For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's \"Source,\" \"From,\" and \"Return-Path\" parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email:</p> <ul> <li> <p> <code>X-SES-SOURCE-ARN</code> </p> </li> <li> <p> <code>X-SES-FROM-ARN</code> </p> </li> <li> <p> <code>X-SES-RETURN-PATH-ARN</code> </p> </li> </ul> <important> <p>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</p> </important> <p>For the most common sending authorization use case, we recommend that you specify the <code>SourceIdentityArn</code> and do not specify either the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code>. (The same note applies to the corresponding X-headers.) If you only specify the <code>SourceIdentityArn</code>, Amazon SES will simply set the \"From\" address and the \"Return Path\" address to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> </li> </ul>",
"SetActiveReceiptRuleSet": "<p>Sets the specified receipt rule set as the active receipt rule set.</p> <note> <p>To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.</p> </note> <p>For information about managing receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"SetIdentityDkimEnabled": "<p>Enables or disables Easy DKIM signing of email sent from an identity:</p> <ul> <li> <p>If Easy DKIM signing is enabled for a domain name identity (e.g., <code>example.com</code>), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., <code>user@example.com</code>).</p> </li> <li> <p>If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.</p> </li> </ul> <p>For email addresses (e.g., <code>user@example.com</code>), you can only enable Easy DKIM signing if the corresponding domain (e.g., <code>example.com</code>) has been set up for Easy DKIM using the AWS Console or the <code>VerifyDomainDkim</code> action.</p> <p>This action is throttled at one request per second.</p> <p>For more information about Easy DKIM signing, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Amazon SES Developer Guide</a>.</p>",
"SetIdentityFeedbackForwardingEnabled": "<p>Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.</p> <note> <p>Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.</p> </note> <p>This action is throttled at one request per second.</p> <p>For more information about using notifications with Amazon SES, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</p>",
"SetIdentityHeadersInNotificationsEnabled": "<p>Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.</p> <p>This action is throttled at one request per second.</p> <p>For more information about using notifications with Amazon SES, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</p>",
"SetIdentityMailFromDomain": "<p>Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).</p> <important> <p>To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html\">Amazon SES Developer Guide</a>.</p> </important> <p>This action is throttled at one request per second.</p>",
"SetIdentityNotificationTopic": "<p>Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the <code>Source</code>.</p> <note> <p>Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see <code>SetIdentityFeedbackForwardingEnabled</code>.</p> </note> <p>This action is throttled at one request per second.</p> <p>For more information about feedback notification, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</p>",
"SetReceiptRulePosition": "<p>Sets the position of the specified receipt rule in the receipt rule set.</p> <p>For information about managing receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"UpdateConfigurationSetEventDestination": "<p>Updates the event destination of a configuration set.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.</p> </note> <p>Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"UpdateReceiptRule": "<p>Updates a receipt rule.</p> <p>For information about managing receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>This action is throttled at one request per second.</p>",
"VerifyDomainDkim": "<p>Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.</p> <p>This action is throttled at one request per second.</p> <p>To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> action.</p> <p>For more information about creating DNS records using DKIM tokens, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html\">Amazon SES Developer Guide</a>.</p>",
"VerifyDomainIdentity": "<p>Verifies a domain.</p> <p>This action is throttled at one request per second.</p>",
"VerifyEmailAddress": "<p>Verifies an email address. This action causes a confirmation email message to be sent to the specified address.</p> <important> <p>The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.</p> </important> <p>This action is throttled at one request per second.</p>",
"VerifyEmailIdentity": "<p>Verifies an email address. This action causes a confirmation email message to be sent to the specified address.</p> <p>This action is throttled at one request per second.</p>"
"CloneReceiptRuleSet": "<p>Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.</p> <p>For information about setting up rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"CreateConfigurationSet": "<p>Creates a configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"CreateConfigurationSetEventDestination": "<p>Creates a configuration set event destination.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).</p> </note> <p>An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"CreateConfigurationSetTrackingOptions": "<p>Creates an association between a configuration set and a custom domain for open and click event tracking. </p> <p>By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html\">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</i> </p>",
"CreateReceiptFilter": "<p>Creates a new IP address filter.</p> <p>For information about setting up IP address filters, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"CreateReceiptRule": "<p>Creates a receipt rule.</p> <p>For information about setting up receipt rules, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"CreateReceiptRuleSet": "<p>Creates an empty receipt rule set.</p> <p>For information about setting up receipt rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DeleteConfigurationSet": "<p>Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DeleteConfigurationSetEventDestination": "<p>Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DeleteConfigurationSetTrackingOptions": "<p>Deletes an association between a configuration set and a custom domain for open and click event tracking.</p> <p>By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html\">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</i> </p> <note> <p>Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.</p> </note>",
"DeleteIdentity": "<p>Deletes the specified identity (an email address or a domain) from the list of verified identities.</p> <p>You can execute this operation no more than once per second.</p>",
"DeleteIdentityPolicy": "<p>Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DeleteReceiptFilter": "<p>Deletes the specified IP address filter.</p> <p>For information about managing IP address filters, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DeleteReceiptRule": "<p>Deletes the specified receipt rule.</p> <p>For information about managing receipt rules, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DeleteReceiptRuleSet": "<p>Deletes the specified receipt rule set and all of the receipt rules it contains.</p> <note> <p>The currently active rule set cannot be deleted.</p> </note> <p>For information about managing receipt rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DeleteVerifiedEmailAddress": "<p>Deprecated. Use the <code>DeleteIdentity</code> operation to delete email addresses and domains.</p>",
"DescribeActiveReceiptRuleSet": "<p>Returns the metadata and receipt rules for the receipt rule set that is currently active.</p> <p>For information about setting up receipt rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DescribeConfigurationSet": "<p>Returns the details of the specified configuration set. For information about using configuration sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DescribeReceiptRule": "<p>Returns the details of the specified receipt rule.</p> <p>For information about setting up receipt rules, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"DescribeReceiptRuleSet": "<p>Returns the details of the specified receipt rule set.</p> <p>For information about managing receipt rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"GetIdentityDkimAttributes": "<p>Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.</p> <p>This operation takes a list of identities as input and returns the following information for each:</p> <ul> <li> <p>Whether Easy DKIM signing is enabled or disabled.</p> </li> <li> <p>A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.</p> </li> <li> <p>Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.</p> </li> </ul> <p>This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.</p> <p>For more information about creating DNS records using DKIM tokens, go to the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html\">Amazon SES Developer Guide</a>.</i> </p>",
"GetIdentityMailFromDomainAttributes": "<p>Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).</p> <p>This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.</p>",
"GetIdentityNotificationAttributes": "<p>Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.</p> <p>This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.</p> <p>For more information about using notifications with Amazon SES, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</i> </p>",
"GetIdentityPolicies": "<p>Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"GetIdentityVerificationAttributes": "<p>Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.</p> <p>The verification status of an email address is \"Pending\" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to \"Success\". If the link is not clicked within 24 hours, the verification status changes to \"Failed.\" In that case, if you still want to verify the email address, you must restart the verification process from the beginning.</p> <p>For domain identities, the domain's verification status is \"Pending\" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, if you still want to verify the domain, you must restart the verification process from the beginning.</p> <p>This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.</p>",
"GetSendQuota": "<p>Provides the sending limits for the Amazon SES account. </p> <p>You can execute this operation no more than once per second.</p>",
"GetSendStatistics": "<p>Provides sending statistics for the Amazon SES account. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.</p> <p>You can execute this operation no more than once per second.</p>",
"ListConfigurationSets": "<p>Provides a list of the configuration sets associated with your Amazon SES account. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Monitoring Your Amazon SES Sending Activity</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second. This operation will return up to 50 configuration sets each time it is run. If your Amazon SES account has more than 50 configuration sets, this operation will also return a NextToken element. You can then execute the <code>ListConfigurationSets</code> operation again, passing the <code>NextToken</code> parameter and the value of the NextToken element to retrieve additional results.</p>",
"ListIdentities": "<p>Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.</p> <p>You can execute this operation no more than once per second.</p>",
"ListIdentityPolicies": "<p>Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use <code>GetIdentityPolicies</code>.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"ListReceiptFilters": "<p>Lists the IP address filters associated with your AWS account.</p> <p>For information about managing IP address filters, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"ListReceiptRuleSets": "<p>Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a <code>NextToken</code> that you can provide to the next call to <code>ListReceiptRuleSets</code> to retrieve the additional entries.</p> <p>For information about managing receipt rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"ListVerifiedEmailAddresses": "<p>Deprecated. Use the <code>ListIdentities</code> operation to list the email addresses and domains associated with your account.</p>",
"PutIdentityPolicy": "<p>Adds or updates a sending authorization policy for the specified identity (an email address or a domain).</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"ReorderReceiptRuleSet": "<p>Reorders the receipt rules within a receipt rule set.</p> <note> <p>All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.</p> </note> <p>For information about managing receipt rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"SendBounce": "<p>Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.</p> <note> <p>You cannot use this API to send generic bounces for mail that was not received by Amazon SES.</p> </note> <p>For information about receiving email through Amazon SES, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"SendEmail": "<p>Composes an email message and immediately queues it for sending. In order to send email using the <code>SendEmail</code> operation, your message must meet the following requirements:</p> <ul> <li> <p>The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an \"Email address not verified\" error. </p> </li> <li> <p>If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide</i>.</p> </li> <li> <p>The total size of the message, including attachments, must be smaller than 10 MB.</p> </li> <li> <p>The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid.</p> </li> <li> <p>The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the <code>SendEmail</code> operation several times to send the message to each group.</p> </li> </ul> <important> <p>For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your <i>sending quota</i>). For more information about sending quotas in Amazon SES, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Managing Your Amazon SES Sending Limits</a> in the <i>Amazon SES Developer Guide</i>.</p> </important>",
"SendRawEmail": "<p>Composes an email message and immediately queues it for sending. When calling this operation, you may specify the message headers as well as the content. The <code>SendRawEmail</code> operation is particularly useful for sending multipart MIME emails (such as those that contain both a plain-text and an HTML version). </p> <p>In order to send email using the <code>SendRawEmail</code> operation, your message must meet the following requirements:</p> <ul> <li> <p>The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an \"Email address not verified\" error. </p> </li> <li> <p>If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide</i>.</p> </li> <li> <p>The total size of the message, including attachments, must be smaller than 10 MB.</p> </li> <li> <p>The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid.</p> </li> <li> <p>The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the <code>SendRawEmail</code> operation several times to send the message to each group.</p> </li> </ul> <important> <p>For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your <i>sending quota</i>). For more information about sending quotas in Amazon SES, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Managing Your Amazon SES Sending Limits</a> in the <i>Amazon SES Developer Guide</i>.</p> </important> <p>Additionally, keep the following considerations in mind when using the <code>SendRawEmail</code> operation:</p> <ul> <li> <p>Although you can customize the message headers when using the <code>SendRawEmail</code> operation, Amazon SES will automatically apply its own <code>Message-ID</code> and <code>Date</code> headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.</p> </li> <li> <p>If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email:</p> <ul> <li> <p> <code>X-SES-SOURCE-ARN</code> </p> </li> <li> <p> <code>X-SES-FROM-ARN</code> </p> </li> <li> <p> <code>X-SES-RETURN-PATH-ARN</code> </p> </li> </ul> <important> <p>Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.</p> </important> <p>For most common sending authorization scenarios, we recommend that you specify the <code>SourceIdentityArn</code> parameter and not the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code> parameters. If you only specify the <code>SourceIdentityArn</code> parameter, Amazon SES will set the From and Return Path addresses to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Using Sending Authorization with Amazon SES</a> in the <i>Amazon SES Developer Guide</i>.</p> </li> </ul>",
"SetActiveReceiptRuleSet": "<p>Sets the specified receipt rule set as the active receipt rule set.</p> <note> <p>To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.</p> </note> <p>For information about managing receipt rule sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"SetIdentityDkimEnabled": "<p>Enables or disables Easy DKIM signing of email sent from an identity:</p> <ul> <li> <p>If Easy DKIM signing is enabled for a domain name identity (such as <code>example.com</code>), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (for example, <code>user@example.com</code>).</p> </li> <li> <p>If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.</p> </li> </ul> <p>For email addresses (for example, <code>user@example.com</code>), you can only enable Easy DKIM signing if the corresponding domain (in this case, <code>example.com</code>) has been set up for Easy DKIM using the AWS Console or the <code>VerifyDomainDkim</code> operation.</p> <p>You can execute this operation no more than once per second.</p> <p>For more information about Easy DKIM signing, go to the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Amazon SES Developer Guide</a>.</i> </p>",
"SetIdentityFeedbackForwardingEnabled": "<p>Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.</p> <note> <p>Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.</p> </note> <p>You can execute this operation no more than once per second.</p> <p>For more information about using notifications with Amazon SES, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</i> </p>",
"SetIdentityHeadersInNotificationsEnabled": "<p>Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.</p> <p>You can execute this operation no more than once per second.</p> <p>For more information about using notifications with Amazon SES, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</i> </p>",
"SetIdentityMailFromDomain": "<p>Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).</p> <important> <p>To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mail-from-set.html\">Amazon SES Developer Guide</a>.</i> </p> </important> <p>You can execute this operation no more than once per second.</p>",
"SetIdentityNotificationTopic": "<p>Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the <code>Source</code>.</p> <note> <p>Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see <code>SetIdentityFeedbackForwardingEnabled</code>.</p> </note> <p>You can execute this operation no more than once per second.</p> <p>For more information about feedback notification, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</i> </p>",
"SetReceiptRulePosition": "<p>Sets the position of the specified receipt rule in the receipt rule set.</p> <p>For information about managing receipt rules, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"UpdateConfigurationSetEventDestination": "<p>Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Monitoring Your Amazon SES Sending Activity</a> in the <i>Amazon SES Developer Guide</i>.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).</p> </note> <p>You can execute this operation no more than once per second.</p>",
"UpdateConfigurationSetTrackingOptions": "<p>Modifies an association between a configuration set and a custom domain for open and click event tracking. </p> <p>By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events by redirecting them to the Amazon SES-operated domain. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html\">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</i> </p>",
"UpdateReceiptRule": "<p>Updates a receipt rule.</p> <p>For information about managing receipt rules, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"VerifyDomainDkim": "<p>Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.</p> <p>You can execute this operation no more than once per second.</p> <p>To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> operation.</p> <p>For more information about creating DNS records using DKIM tokens, go to the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html\">Amazon SES Developer Guide</a>.</i> </p>",
"VerifyDomainIdentity": "<p>Adds a domain to the list of identities for your Amazon SES account and attempts to verify it. For more information about verifying domains, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>",
"VerifyEmailAddress": "<p>Deprecated. Use the <code>VerifyEmailIdentity</code> operation to verify a new email address.</p>",
"VerifyEmailIdentity": "<p>Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. This operation causes a confirmation email message to be sent to the specified address.</p> <p>You can execute this operation no more than once per second.</p>"
},
"shapes": {
"AddHeaderAction": {
@@ -66,11 +69,11 @@
"BounceAction$Sender": "<p>The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.</p>",
"BouncedRecipientInfo$Recipient": "<p>The email address of the recipient of the bounced email.</p>",
"DeleteVerifiedEmailAddressRequest$EmailAddress": "<p>An email address to be removed from the list of verified addresses.</p>",
"RecipientDsnFields$FinalRecipient": "<p>The email address to which the message was ultimately delivered. This corresponds to the <code>Final-Recipient</code> in the DSN. If not specified, <code>FinalRecipient</code> will be set to the <code>Recipient</code> specified in the <code>BouncedRecipientInfo</code> structure. Either <code>FinalRecipient</code> or the recipient in <code>BouncedRecipientInfo</code> must be a recipient of the original bounced message.</p> <note> <p>Do not prepend the <code>FinalRecipient</code> email address with <code>rfc 822;</code>, as described in <a href=\"https://tools.ietf.org/html/rfc3798\">RFC 3798</a>.</p> </note>",
"RecipientDsnFields$FinalRecipient": "<p>The email address that the message was ultimately delivered to. This corresponds to the <code>Final-Recipient</code> in the DSN. If not specified, <code>FinalRecipient</code> will be set to the <code>Recipient</code> specified in the <code>BouncedRecipientInfo</code> structure. Either <code>FinalRecipient</code> or the recipient in <code>BouncedRecipientInfo</code> must be a recipient of the original bounced message.</p> <note> <p>Do not prepend the <code>FinalRecipient</code> email address with <code>rfc 822;</code>, as described in <a href=\"https://tools.ietf.org/html/rfc3798\">RFC 3798</a>.</p> </note>",
"SendBounceRequest$BounceSender": "<p>The address to use in the \"From\" header of the bounce message. This must be an identity that you have verified with Amazon SES.</p>",
"SendEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p> In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"http://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"SendEmailRequest$ReturnPath": "<p>The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </p>",
"SendRawEmailRequest$Source": "<p>The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)</p> <p> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"http://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p> <note> <p>If you specify the <code>Source</code> parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any <i>Return-Path</i> header that you might include in the raw text of the message.</p> </note>",
"SendEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p> In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"SendEmailRequest$ReturnPath": "<p>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </p>",
"SendRawEmailRequest$Source": "<p>The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)</p> <p> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p> <note> <p>If you specify the <code>Source</code> parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.</p> </note>",
"VerifyEmailAddressRequest$EmailAddress": "<p>The email address to be verified.</p>",
"VerifyEmailIdentityRequest$EmailAddress": "<p>The email address to be verified.</p>"
}
@@ -96,15 +99,16 @@
"refs": {
"BounceAction$TopicArn": "<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href=\"http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html\">Amazon SNS Developer Guide</a>.</p>",
"BouncedRecipientInfo$RecipientArn": "<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p>",
"InvalidLambdaFunctionException$FunctionArn": null,
"InvalidSnsTopicException$Topic": null,
"InvalidLambdaFunctionException$FunctionArn": "<p>Indicates that the ARN of the function was not found.</p>",
"InvalidSnsTopicException$Topic": "<p>Indicates that the topic does not exist.</p>",
"KinesisFirehoseDestination$IAMRoleARN": "<p>The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.</p>",
"KinesisFirehoseDestination$DeliveryStreamARN": "<p>The ARN of the Amazon Kinesis Firehose stream to which to publish email sending events.</p>",
"LambdaAction$TopicArn": "<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href=\"http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html\">Amazon SNS Developer Guide</a>.</p>",
"LambdaAction$FunctionArn": "<p>The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is <code>arn:aws:lambda:us-west-2:account-id:function:MyFunction</code>. For more information about AWS Lambda, see the <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/welcome.html\">AWS Lambda Developer Guide</a>.</p>",
"KinesisFirehoseDestination$DeliveryStreamARN": "<p>The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.</p>",
"LambdaAction$TopicArn": "<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <i> <a href=\"http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html\">Amazon SNS Developer Guide</a>.</i> </p>",
"LambdaAction$FunctionArn": "<p>The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is <code>arn:aws:lambda:us-west-2:account-id:function:MyFunction</code>. For more information about AWS Lambda, see the <i> <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/welcome.html\">AWS Lambda Developer Guide</a>.</i> </p>",
"S3Action$TopicArn": "<p>The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href=\"http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html\">Amazon SNS Developer Guide</a>.</p>",
"S3Action$KmsKeyArn": "<p>The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:</p> <ul> <li> <p>To use the default master key, provide an ARN in the form of <code>arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses</code>. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be <code>arn:aws:kms:us-west-2:123456789012:alias/aws/ses</code>. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.</p> </li> <li> <p>To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html\">Amazon SES Developer Guide</a>.</p> </li> </ul> <p>For more information about key policies, see the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">AWS KMS Developer Guide</a>. If you do not specify a master key, Amazon SES will not encrypt your emails.</p> <important> <p>Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the <a href=\"http://aws.amazon.com/sdk-for-java/\">AWS Java SDK</a> and <a href=\"http://aws.amazon.com/sdk-for-ruby/\">AWS Ruby SDK</a> only. For more information about client-side encryption using AWS KMS master keys, see the <a href=\"http://alpha-docs-aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html\">Amazon S3 Developer Guide</a>.</p> </important>",
"S3Action$KmsKeyArn": "<p>The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:</p> <ul> <li> <p>To use the default master key, provide an ARN in the form of <code>arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses</code>. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be <code>arn:aws:kms:us-west-2:123456789012:alias/aws/ses</code>. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.</p> </li> <li> <p>To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html\">Amazon SES Developer Guide</a>.</p> </li> </ul> <p>For more information about key policies, see the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">AWS KMS Developer Guide</a>. If you do not specify a master key, Amazon SES will not encrypt your emails.</p> <important> <p>Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the <a href=\"http://aws.amazon.com/sdk-for-java/\">AWS Java SDK</a> and <a href=\"http://aws.amazon.com/sdk-for-ruby/\">AWS Ruby SDK</a> only. For more information about client-side encryption using AWS KMS master keys, see the <a href=\"AmazonS3/latest/dev/UsingClientSideEncryption.html\">Amazon S3 Developer Guide</a>.</p> </important>",
"SNSAction$TopicArn": "<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <a href=\"http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html\">Amazon SNS Developer Guide</a>.</p>",
"SNSDestination$TopicARN": "<p>The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is <code>arn:aws:sns:us-west-2:123456789012:MyTopic</code>. For more information about Amazon SNS topics, see the <i> <a href=\"http://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html\">Amazon SNS Developer Guide</a>.</i> </p>",
"SendBounceRequest$BounceSenderArn": "<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the \"From\" header of the bounce. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p>",
"SendEmailRequest$SourceArn": "<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the <code>Source</code> parameter.</p> <p>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to send from <code>user@example.com</code>, then you would specify the <code>SourceArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>Source</code> to be <code>user@example.com</code>.</p> <p>For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>. </p>",
"SendEmailRequest$ReturnPathArn": "<p>This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the <code>ReturnPath</code> parameter.</p> <p>For example, if the owner of <code>example.com</code> (which has ARN <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>) attaches a policy to it that authorizes you to use <code>feedback@example.com</code>, then you would specify the <code>ReturnPathArn</code> to be <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>, and the <code>ReturnPath</code> to be <code>feedback@example.com</code>.</p> <p>For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>. </p>",
@@ -223,7 +227,7 @@
}
},
"ConfigurationSet": {
"base": "<p>The name of the configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>",
"base": "<p>The name of the configuration set.</p> <p>Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html\">Using Amazon SES Configuration Sets</a> in the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/\">Amazon SES Developer Guide</a>.</i> </p>",
"refs": {
"ConfigurationSets$member": null,
"CreateConfigurationSetRequest$ConfigurationSet": "<p>A data structure that contains the name of the configuration set.</p>",
@@ -255,20 +259,26 @@
"ConfigurationSetName": {
"base": null,
"refs": {
"ConfigurationSet$Name": "<p>The name of the configuration set. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"ConfigurationSetAlreadyExistsException$ConfigurationSetName": null,
"ConfigurationSetDoesNotExistException$ConfigurationSetName": null,
"CreateConfigurationSetEventDestinationRequest$ConfigurationSetName": "<p>The name of the configuration set to which to apply the event destination.</p>",
"ConfigurationSet$Name": "<p>The name of the configuration set. The name must meet the following requirements:</p> <ul> <li> <p>Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain 64 characters or fewer.</p> </li> </ul>",
"ConfigurationSetAlreadyExistsException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"ConfigurationSetDoesNotExistException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"CreateConfigurationSetEventDestinationRequest$ConfigurationSetName": "<p>The name of the configuration set that the event destination should be associated with.</p>",
"CreateConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "<p>The name of the configuration set that the tracking options should be associated with.</p>",
"DeleteConfigurationSetEventDestinationRequest$ConfigurationSetName": "<p>The name of the configuration set from which to delete the event destination.</p>",
"DeleteConfigurationSetRequest$ConfigurationSetName": "<p>The name of the configuration set to delete.</p>",
"DeleteConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "<p>The name of the configuration set from which you want to delete the tracking options.</p>",
"DescribeConfigurationSetRequest$ConfigurationSetName": "<p>The name of the configuration set to describe.</p>",
"EventDestinationAlreadyExistsException$ConfigurationSetName": null,
"EventDestinationDoesNotExistException$ConfigurationSetName": null,
"InvalidCloudWatchDestinationException$ConfigurationSetName": null,
"InvalidFirehoseDestinationException$ConfigurationSetName": null,
"EventDestinationAlreadyExistsException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"EventDestinationDoesNotExistException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"InvalidCloudWatchDestinationException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"InvalidFirehoseDestinationException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"InvalidSNSDestinationException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"SendEmailRequest$ConfigurationSetName": "<p>The name of the configuration set to use when you send an email using <code>SendEmail</code>.</p>",
"SendRawEmailRequest$ConfigurationSetName": "<p>The name of the configuration set to use when you send an email using <code>SendRawEmail</code>.</p>",
"UpdateConfigurationSetEventDestinationRequest$ConfigurationSetName": "<p>The name of the configuration set that you want to update.</p>"
"TrackingOptionsAlreadyExistsException$ConfigurationSetName": "<p>Indicates that a TrackingOptions object already exists in the specified configuration set.</p>",
"TrackingOptionsDoesNotExistException$ConfigurationSetName": "<p>Indicates that a TrackingOptions object does not exist in the specified configuration set.</p>",
"UpdateConfigurationSetEventDestinationRequest$ConfigurationSetName": "<p>The name of the configuration set that contains the event destination that you want to update.</p>",
"UpdateConfigurationSetTrackingOptionsRequest$ConfigurationSetName": "<p>The name of the configuration set for which you want to update the custom tracking domain.</p>"
}
},
"ConfigurationSets": {
@@ -314,6 +324,16 @@
"refs": {
}
},
"CreateConfigurationSetTrackingOptionsRequest": {
"base": "<p>Represents a request to create an open and click tracking option object in a configuration set. </p>",
"refs": {
}
},
"CreateConfigurationSetTrackingOptionsResponse": {
"base": "<p>An empty element returned on a successful request.</p>",
"refs": {
}
},
"CreateReceiptFilterRequest": {
"base": "<p>Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@@ -350,6 +370,12 @@
"IdentityMailFromDomainAttributes$MailFromDomainStatus": "<p>The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is <code>Success</code>, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by <code>BehaviorOnMXFailure</code>.</p>"
}
},
"CustomRedirectDomain": {
"base": null,
"refs": {
"TrackingOptions$CustomRedirectDomain": "<p>The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.</p>"
}
},
"DefaultDimensionValue": {
"base": null,
"refs": {
@@ -376,6 +402,16 @@
"refs": {
}
},
"DeleteConfigurationSetTrackingOptionsRequest": {
"base": "<p>Represents a request to delete open and click tracking options in a configuration set. </p>",
"refs": {
}
},
"DeleteConfigurationSetTrackingOptionsResponse": {
"base": "<p>An empty element returned on a successful request.</p>",
"refs": {
}
},
"DeleteIdentityPolicyRequest": {
"base": "<p>Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@@ -472,7 +508,7 @@
}
},
"Destination": {
"base": "<p>Represents the destination of the message, consisting of To:, CC:, and BCC: fields.</p> <p> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"http://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"base": "<p>Represents the destination of the message, consisting of To:, CC:, and BCC: fields.</p> <p> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"refs": {
"SendEmailRequest$Destination": "<p>The destination for this email, composed of To:, CC:, and BCC: fields.</p>"
}
@@ -530,16 +566,16 @@
"IdentityNotificationAttributes$HeadersInComplaintNotificationsEnabled": "<p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type <code>Complaint</code>. A value of <code>true</code> specifies that Amazon SES will include headers in complaint notifications, and a value of <code>false</code> specifies that Amazon SES will not include headers in complaint notifications.</p>",
"IdentityNotificationAttributes$HeadersInDeliveryNotificationsEnabled": "<p>Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type <code>Delivery</code>. A value of <code>true</code> specifies that Amazon SES will include headers in delivery notifications, and a value of <code>false</code> specifies that Amazon SES will not include headers in delivery notifications.</p>",
"ReceiptRule$Enabled": "<p>If <code>true</code>, the receipt rule is active. The default value is <code>false</code>.</p>",
"ReceiptRule$ScanEnabled": "<p>If <code>true</code>, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is <code>false</code>.</p>",
"ReceiptRule$ScanEnabled": "<p>If <code>true</code>, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is <code>false</code>.</p>",
"SetIdentityDkimEnabledRequest$DkimEnabled": "<p>Sets whether DKIM signing is enabled for an identity. Set to <code>true</code> to enable DKIM signing for this identity; <code>false</code> to disable it. </p>",
"SetIdentityFeedbackForwardingEnabledRequest$ForwardingEnabled": "<p>Sets whether Amazon SES will forward bounce and complaint notifications as email. <code>true</code> specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. <code>false</code> specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to <code>false</code> when Amazon SNS topics are set for both <code>Bounce</code> and <code>Complaint</code> notification types.</p>",
"SetIdentityHeadersInNotificationsEnabledRequest$Enabled": "<p>Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of <code>true</code> specifies that Amazon SES will include headers in notifications, and a value of <code>false</code> specifies that Amazon SES will not include headers in notifications.</p> <p>This value can only be set when <code>NotificationType</code> is already set to use a particular Amazon SNS topic.</p>"
}
},
"EventDestination": {
"base": "<p>Contains information about the event destination to which the specified email sending events are published.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.</p> </note> <p>Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>",
"base": "<p>Contains information about the event destination that the specified email sending events will be published to.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).</p> </note> <p>Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
"CreateConfigurationSetEventDestinationRequest$EventDestination": "<p>An object that describes the AWS service to which Amazon SES will publish the email sending events associated with the specified configuration set.</p>",
"CreateConfigurationSetEventDestinationRequest$EventDestination": "<p>An object that describes the AWS service that email sending event information will be published to.</p>",
"EventDestinations$member": null,
"UpdateConfigurationSetEventDestinationRequest$EventDestination": "<p>The event destination object that you want to apply to the specified configuration set.</p>"
}
@@ -559,10 +595,11 @@
"refs": {
"DeleteConfigurationSetEventDestinationRequest$EventDestinationName": "<p>The name of the event destination to delete.</p>",
"EventDestination$Name": "<p>The name of the event destination. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"EventDestinationAlreadyExistsException$EventDestinationName": null,
"EventDestinationDoesNotExistException$EventDestinationName": null,
"InvalidCloudWatchDestinationException$EventDestinationName": null,
"InvalidFirehoseDestinationException$EventDestinationName": null
"EventDestinationAlreadyExistsException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>",
"EventDestinationDoesNotExistException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>",
"InvalidCloudWatchDestinationException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>",
"InvalidFirehoseDestinationException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>",
"InvalidSNSDestinationException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>"
}
},
"EventDestinations": {
@@ -697,7 +734,7 @@
"ListIdentityPoliciesRequest$Identity": "<p>The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p> <p>To successfully call this API, you must own the identity.</p>",
"MailFromDomainAttributes$key": null,
"NotificationAttributes$key": null,
"PutIdentityPolicyRequest$Identity": "<p>The identity to which the policy will apply. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p> <p>To successfully call this API, you must own the identity.</p>",
"PutIdentityPolicyRequest$Identity": "<p>The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>user@example.com</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p> <p>To successfully call this API, you must own the identity.</p>",
"SetIdentityDkimEnabledRequest$Identity": "<p>The identity for which DKIM signing should be enabled or disabled.</p>",
"SetIdentityFeedbackForwardingEnabledRequest$Identity": "<p>The identity for which to set bounce and complaint notification forwarding. Examples: <code>user@example.com</code>, <code>example.com</code>.</p>",
"SetIdentityHeadersInNotificationsEnabledRequest$Identity": "<p>The identity for which to enable or disable headers in notifications. Examples: <code>user@example.com</code>, <code>example.com</code>.</p>",
@@ -776,25 +813,35 @@
"refs": {
}
},
"InvalidSNSDestinationException": {
"base": "<p>Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.</p>",
"refs": {
}
},
"InvalidSnsTopicException": {
"base": "<p>Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
}
},
"InvalidTrackingOptionsException": {
"base": "<p>Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:</p> <ul> <li> <p>When the tracking domain you specified is not verified in Amazon SES.</p> </li> <li> <p>When the tracking domain you specified is not a valid domain or subdomain.</p> </li> </ul>",
"refs": {
}
},
"InvocationType": {
"base": null,
"refs": {
"LambdaAction$InvocationType": "<p>The invocation type of the AWS Lambda function. An invocation type of <code>RequestResponse</code> means that the execution of the function will immediately result in a response, and a value of <code>Event</code> means that the function will be invoked asynchronously. The default value is <code>Event</code>. For information about AWS Lambda invocation types, see the <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html\">AWS Lambda Developer Guide</a>.</p> <important> <p>There is a 30-second timeout on <code>RequestResponse</code> invocations. You should use <code>Event</code> invocation in most cases. Use <code>RequestResponse</code> only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.</p> </important>"
"LambdaAction$InvocationType": "<p>The invocation type of the AWS Lambda function. An invocation type of <code>RequestResponse</code> means that the execution of the function will immediately result in a response, and a value of <code>Event</code> means that the function will be invoked asynchronously. The default value is <code>Event</code>. For information about AWS Lambda invocation types, see the <i> <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html\">AWS Lambda Developer Guide</a>.</i> </p> <important> <p>There is a 30-second timeout on <code>RequestResponse</code> invocations. You should use <code>Event</code> invocation in most cases. Use <code>RequestResponse</code> only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.</p> </important>"
}
},
"KinesisFirehoseDestination": {
"base": "<p>Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.</p> <p>Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>",
"base": "<p>Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.</p> <p>Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</i> </p>",
"refs": {
"EventDestination$KinesisFirehoseDestination": "<p>An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.</p>"
}
},
"LambdaAction": {
"base": "<p>When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p> <p>To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html\">Amazon SES Developer Guide</a>.</p> <p>For information about using AWS Lambda actions in receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html\">Amazon SES Developer Guide</a>.</p>",
"base": "<p>When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p> <p>To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-permissions.html\">Amazon SES Developer Guide</a>.</i> </p> <p>For information about using AWS Lambda actions in receipt rules, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html\">Amazon SES Developer Guide</a>.</i> </p>",
"refs": {
"ReceiptAction$LambdaAction": "<p>Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.</p>"
}
@@ -915,7 +962,7 @@
}
},
"MessageDsn": {
"base": "<p>Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.</p> <p>For information about receiving email through Amazon SES, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html\">Amazon SES Developer Guide</a>.</p>",
"base": "<p>Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.</p> <p>For information about receiving email through Amazon SES, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html\">Amazon SES Developer Guide</a>.</i> </p>",
"refs": {
"SendBounceRequest$MessageDsn": "<p>Message-related DSN fields. If not specified, Amazon SES will choose the values.</p>"
}
@@ -1034,13 +1081,13 @@
"RawMessage": {
"base": "<p>Represents the raw data of the message.</p>",
"refs": {
"SendRawEmailRequest$RawMessage": "<p>The raw text of the message. The client is responsible for ensuring the following:</p> <ul> <li> <p>Message must contain a header and a body, separated by a blank line.</p> </li> <li> <p>All required header fields must be present.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>MIME content types must be among those supported by Amazon SES. For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>Must be base64-encoded.</p> </li> </ul>"
"SendRawEmailRequest$RawMessage": "<p>The raw text of the message. The client is responsible for ensuring the following:</p> <ul> <li> <p>Message must contain a header and a body, separated by a blank line.</p> </li> <li> <p>All required header fields must be present.</p> </li> <li> <p>Each part of a multipart MIME message must be formatted properly.</p> </li> <li> <p>MIME content types must be among those supported by Amazon SES. For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/mime-types.html\">Amazon SES Developer Guide</a>.</p> </li> <li> <p>Must be base64-encoded.</p> </li> <li> <p>Per <a href=\"https://tools.ietf.org/html/rfc5321#section-4.5.3.1.6\">RFC 5321</a>, the maximum length of each line of text, including the &lt;CRLF&gt;, must not exceed 1,000 characters.</p> </li> </ul>"
}
},
"RawMessageData": {
"base": null,
"refs": {
"RawMessage$Data": "<p>The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding.</p> <p>The To:, CC:, and BCC: headers in the raw message can contain a group list.</p> <p>If you are using <code>SendRawEmail</code> with sending authorization, you can include X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\" addresses. For more information, see the documentation for <code>SendRawEmail</code>. </p> <important> <p>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</p> </important> <p>For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html\">Amazon SES Developer Guide</a>. </p>"
"RawMessage$Data": "<p>The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.</p> <p>The To:, CC:, and BCC: headers in the raw message can contain a group list.</p> <p>If you are using <code>SendRawEmail</code> with sending authorization, you can include X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\" addresses. For more information, see the documentation for <code>SendRawEmail</code>. </p> <important> <p>Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.</p> </important> <p>For more information, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html\">Amazon SES Developer Guide</a>. </p>"
}
},
"ReceiptAction": {
@@ -1088,7 +1135,7 @@
}
},
"ReceiptRule": {
"base": "<p>Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.</p> <p>Each receipt rule defines a set of email addresses or domains to which it applies. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.</p> <p>For information about setting up receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</p>",
"base": "<p>Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.</p> <p>Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.</p> <p>For information about setting up receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
"CreateReceiptRuleRequest$Rule": "<p>A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.</p>",
"DescribeReceiptRuleResponse$Rule": "<p>A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.</p>",
@@ -1127,17 +1174,17 @@
"refs": {
"CloneReceiptRuleSetRequest$RuleSetName": "<p>The name of the rule set to create. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"CloneReceiptRuleSetRequest$OriginalRuleSetName": "<p>The name of the rule set to clone.</p>",
"CreateReceiptRuleRequest$RuleSetName": "<p>The name of the rule set to which to add the rule.</p>",
"CreateReceiptRuleRequest$RuleSetName": "<p>The name of the rule set that the receipt rule will be added to.</p>",
"CreateReceiptRuleSetRequest$RuleSetName": "<p>The name of the rule set to create. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"DeleteReceiptRuleRequest$RuleSetName": "<p>The name of the receipt rule set that contains the receipt rule to delete.</p>",
"DeleteReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to delete.</p>",
"DescribeReceiptRuleRequest$RuleSetName": "<p>The name of the receipt rule set to which the receipt rule belongs.</p>",
"DescribeReceiptRuleRequest$RuleSetName": "<p>The name of the receipt rule set that the receipt rule belongs to.</p>",
"DescribeReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to describe.</p>",
"ReceiptRuleSetMetadata$Name": "<p>The name of the receipt rule set. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"ReorderReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to reorder.</p>",
"SetActiveReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to make active. Setting this value to null disables all email receiving.</p>",
"SetReceiptRulePositionRequest$RuleSetName": "<p>The name of the receipt rule set that contains the receipt rule to reposition.</p>",
"UpdateReceiptRuleRequest$RuleSetName": "<p>The name of the receipt rule set to which the receipt rule belongs.</p>"
"UpdateReceiptRuleRequest$RuleSetName": "<p>The name of the receipt rule set that the receipt rule belongs to.</p>"
}
},
"ReceiptRuleSetsLists": {
@@ -1168,7 +1215,7 @@
"RecipientsList": {
"base": null,
"refs": {
"ReceiptRule$Recipients": "<p>The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.</p>"
"ReceiptRule$Recipients": "<p>The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.</p>"
}
},
"RemoteMta": {
@@ -1201,10 +1248,10 @@
"RuleOrRuleSetName": {
"base": null,
"refs": {
"AlreadyExistsException$Name": null,
"CannotDeleteException$Name": null,
"RuleDoesNotExistException$Name": null,
"RuleSetDoesNotExistException$Name": null
"AlreadyExistsException$Name": "<p>Indicates that a resource could not be created because the resource name already exists.</p>",
"CannotDeleteException$Name": "<p>Indicates that a resource could not be deleted because no resource with the specified name exists.</p>",
"RuleDoesNotExistException$Name": "<p>Indicates that the named receipt rule does not exist.</p>",
"RuleSetDoesNotExistException$Name": "<p>Indicates that the named receipt rule set does not exist.</p>"
}
},
"RuleSetDoesNotExistException": {
@@ -1221,8 +1268,8 @@
"S3BucketName": {
"base": null,
"refs": {
"InvalidS3ConfigurationException$Bucket": null,
"S3Action$BucketName": "<p>The name of the Amazon S3 bucket to which to save the received email.</p>"
"InvalidS3ConfigurationException$Bucket": "<p>Indicated that the S3 Bucket was not found.</p>",
"S3Action$BucketName": "<p>The name of the Amazon S3 bucket that incoming email will be saved to.</p>"
}
},
"S3KeyPrefix": {
@@ -1243,6 +1290,12 @@
"SNSAction$Encoding": "<p>The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.</p>"
}
},
"SNSDestination": {
"base": "<p>Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.</p> <p>Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</i> </p>",
"refs": {
"EventDestination$SNSDestination": "<p>An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.</p>"
}
},
"SendBounceRequest": {
"base": "<p>Represents a request to send a bounce message to the sender of an email you received through Amazon SES.</p>",
"refs": {
@@ -1362,7 +1415,7 @@
}
},
"StopAction": {
"base": "<p>When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p> <p>For information about setting a stop action in a receipt rule, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html\">Amazon SES Developer Guide</a>.</p>",
"base": "<p>When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).</p> <p>For information about setting a stop action in a receipt rule, see the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html\">Amazon SES Developer Guide</a>.</i> </p>",
"refs": {
"ReceiptAction$StopAction": "<p>Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.</p>"
}
@@ -1370,7 +1423,7 @@
"StopScope": {
"base": null,
"refs": {
"StopAction$Scope": "<p>The scope to which the Stop action applies. That is, what is being stopped.</p>"
"StopAction$Scope": "<p>The name of the RuleSet that is being stopped.</p>"
}
},
"Timestamp": {
@@ -1386,6 +1439,24 @@
"ReceiptRule$TlsPolicy": "<p>Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to <code>Require</code>, Amazon SES will bounce emails that are not received over TLS. The default is <code>Optional</code>.</p>"
}
},
"TrackingOptions": {
"base": "<p>A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html\">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <i> <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</i> </p>",
"refs": {
"CreateConfigurationSetTrackingOptionsRequest$TrackingOptions": null,
"DescribeConfigurationSetResponse$TrackingOptions": "<p>The name of the custom open and click tracking domain associated with the configuration set.</p>",
"UpdateConfigurationSetTrackingOptionsRequest$TrackingOptions": null
}
},
"TrackingOptionsAlreadyExistsException": {
"base": "<p>Indicates that the configuration set you specified already contains a TrackingOptions object.</p>",
"refs": {
}
},
"TrackingOptionsDoesNotExistException": {
"base": "<p>Indicates that the TrackingOptions object you specified does not exist.</p>",
"refs": {
}
},
"UpdateConfigurationSetEventDestinationRequest": {
"base": "<p>Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@@ -1396,6 +1467,16 @@
"refs": {
}
},
"UpdateConfigurationSetTrackingOptionsRequest": {
"base": "<p>Represents a request to update the tracking options for a configuration set. </p>",
"refs": {
}
},
"UpdateConfigurationSetTrackingOptionsResponse": {
"base": "<p>An empty element returned on a successful request.</p>",
"refs": {
}
},
"UpdateReceiptRuleRequest": {
"base": "<p>Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@@ -1424,7 +1505,7 @@
"refs": {
"IdentityVerificationAttributes$VerificationToken": "<p>The verification token for a domain identity. Null for email address identities.</p>",
"VerificationTokenList$member": null,
"VerifyDomainIdentityResponse$VerificationToken": "<p>A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.</p>"
"VerifyDomainIdentityResponse$VerificationToken": "<p>A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.</p> <p>As Amazon SES searches for the TXT record, the domain's verification status is \"Pending\". When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, if you still want to verify the domain, you must restart the verification process from the beginning.</p>"
}
},
"VerificationTokenList": {

2
vendor/github.com/aws/aws-sdk-go/models/apis/email/2010-12-01/examples-1.json generated vendored
View File

@@ -367,6 +367,8 @@
"NotificationAttributes": {
"example.com": {
"BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
"ComplaintTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
"DeliveryTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic",
"ForwardingEnabled": true,
"HeadersInBounceNotificationsEnabled": false,
"HeadersInComplaintNotificationsEnabled": false,

4
vendor/github.com/aws/aws-sdk-go/models/apis/email/2010-12-01/paginators-1.json generated vendored
View File

@@ -2,12 +2,12 @@
"pagination": {
"ListIdentities": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxItems",
"output_token": "NextToken",
"result_key": "Identities"
},
"ListVerifiedEmailAddresses": {
"result_key": "VerifiedEmailAddresses"
}
}
}
}

6
vendor/github.com/aws/aws-sdk-go/models/apis/events/2015-10-07/api-2.json generated vendored
View File

@@ -134,7 +134,8 @@
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"PolicyLengthExceededException"},
{"shape":"InternalException"}
{"shape":"InternalException"},
{"shape":"ConcurrentModificationException"}
]
},
"PutRule":{
@@ -176,7 +177,8 @@
"input":{"shape":"RemovePermissionRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalException"}
{"shape":"InternalException"},
{"shape":"ConcurrentModificationException"}
]
},
"RemoveTargets":{

4
vendor/github.com/aws/aws-sdk-go/models/apis/events/2015-10-07/docs-2.json generated vendored
View File

@@ -11,9 +11,9 @@
"ListRules": "<p>Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names.</p>",
"ListTargetsByRule": "<p>Lists the targets assigned to the specified rule.</p>",
"PutEvents": "<p>Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.</p>",
"PutPermission": "<p>Running <code>PutPermission</code> permits the specified AWS account to put events to your account's default <i>event bus</i>. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus. </p> <p>For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.</p> <p>To enable multiple AWS accounts to put events to your default event bus, run <code>PutPermission</code> once for each of these accounts.</p>",
"PutPermission": "<p>Running <code>PutPermission</code> permits the specified AWS account to put events to your account's default <i>event bus</i>. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus. </p> <p>For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.</p> <p>To enable multiple AWS accounts to put events to your default event bus, run <code>PutPermission</code> once for each of these accounts.</p> <p>The permission policy on the default event bus cannot exceed 10KB in size.</p>",
"PutRule": "<p>Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using <a>DisableRule</a>.</p> <p>When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.</p> <p>A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.</p> <p>Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.</p>",
"PutTargets": "<p>Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.</p> <p>Targets are the resources that are invoked when a rule is triggered.</p> <p>You can configure the following as targets for CloudWatch Events:</p> <ul> <li> <p>EC2 instances</p> </li> <li> <p>AWS Lambda functions</p> </li> <li> <p>Streams in Amazon Kinesis Streams</p> </li> <li> <p>Delivery streams in Amazon Kinesis Firehose</p> </li> <li> <p>Amazon ECS tasks</p> </li> <li> <p>AWS Step Functions state machines</p> </li> <li> <p>Amazon SNS topics</p> </li> <li> <p>Amazon SQS queues</p> </li> </ul> <p>Note that creating rules with built-in targets is supported only in the AWS Management Console.</p> <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2 instances with one rule, you can use the <code>RunCommandParameters</code> field.</p> <p>To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/auth-and-access-control-cwe.html\">Authentication and Access Control</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> <p>If another AWS account is in the same region and has granted you permission (using <code>PutPermission</code>), you can set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the <code>Arn</code> when you run <code>PutTargets</code>. For more information about enabling cross-account events, see <a>PutPermission</a>.</p> <p> <b>Input</b>, <b>InputPath</b> and <b>InputTransformer</b> are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:</p> <ul> <li> <p>If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).</p> </li> <li> <p>If <b>Input</b> is specified in the form of valid JSON, then the matched event is overridden with this constant.</p> </li> <li> <p>If <b>InputPath</b> is specified in the form of JSONPath (for example, <code>$.detail</code>), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).</p> </li> <li> <p>If <b>InputTransformer</b> is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.</p> </li> </ul> <p>When you specify <code>Input</code>, <code>InputPath</code>, or <code>InputTransformer</code>, you must use JSON dot notation, not bracket notation.</p> <p>When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.</p> <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>",
"PutTargets": "<p>Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.</p> <p>Targets are the resources that are invoked when a rule is triggered.</p> <p>You can configure the following as targets for CloudWatch Events:</p> <ul> <li> <p>EC2 instances</p> </li> <li> <p>AWS Lambda functions</p> </li> <li> <p>Streams in Amazon Kinesis Streams</p> </li> <li> <p>Delivery streams in Amazon Kinesis Firehose</p> </li> <li> <p>Amazon ECS tasks</p> </li> <li> <p>AWS Step Functions state machines</p> </li> <li> <p>Pipelines in Amazon Code Pipeline</p> </li> <li> <p>Amazon Inspector assessment templates</p> </li> <li> <p>Amazon SNS topics</p> </li> <li> <p>Amazon SQS queues</p> </li> <li> <p>The default event bus of another AWS account</p> </li> </ul> <p>Note that creating rules with built-in targets is supported only in the AWS Management Console.</p> <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2 instances with one rule, you can use the <code>RunCommandParameters</code> field.</p> <p>To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/auth-and-access-control-cwe.html\">Authentication and Access Control</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> <p>If another AWS account is in the same region and has granted you permission (using <code>PutPermission</code>), you can send events to that account by setting that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the <code>Arn</code> when you run <code>PutTargets</code>. If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>For more information about enabling cross-account events, see <a>PutPermission</a>.</p> <p> <b>Input</b>, <b>InputPath</b> and <b>InputTransformer</b> are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:</p> <ul> <li> <p>If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).</p> </li> <li> <p>If <b>Input</b> is specified in the form of valid JSON, then the matched event is overridden with this constant.</p> </li> <li> <p>If <b>InputPath</b> is specified in the form of JSONPath (for example, <code>$.detail</code>), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).</p> </li> <li> <p>If <b>InputTransformer</b> is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.</p> </li> </ul> <p>When you specify <code>Input</code>, <code>InputPath</code>, or <code>InputTransformer</code>, you must use JSON dot notation, not bracket notation.</p> <p>When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.</p> <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>",
"RemovePermission": "<p>Revokes the permission of another AWS account to be able to put events to your default event bus. Specify the account to revoke by the <code>StatementId</code> value that you associated with the account when you granted it permission with <code>PutPermission</code>. You can find the <code>StatementId</code> by using <a>DescribeEventBus</a>.</p>",
"RemoveTargets": "<p>Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.</p> <p>When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Please allow a short period of time for changes to take effect.</p> <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>",
"TestEventPattern": "<p>Tests whether the specified event pattern matches the provided event.</p> <p>Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.</p>"

101
vendor/github.com/aws/aws-sdk-go/models/apis/firehose/2015-08-04/api-2.json generated vendored
View File

@@ -51,6 +51,21 @@
{"shape":"ResourceNotFoundException"}
]
},
"GetKinesisStream":{
"name":"GetKinesisStream",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetKinesisStreamInput"},
"output":{"shape":"GetKinesisStreamOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgumentException"},
{"shape":"InvalidStreamTypeException"}
],
"internalonly":true
},
"ListDeliveryStreams":{
"name":"ListDeliveryStreams",
"http":{
@@ -111,6 +126,7 @@
"min":1,
"pattern":"arn:.*"
},
"AccessKeyId":{"type":"string"},
"BooleanObject":{"type":"boolean"},
"BucketARN":{
"type":"string",
@@ -169,6 +185,8 @@
"required":["DeliveryStreamName"],
"members":{
"DeliveryStreamName":{"shape":"DeliveryStreamName"},
"DeliveryStreamType":{"shape":"DeliveryStreamType"},
"KinesisStreamSourceConfiguration":{"shape":"KinesisStreamSourceConfiguration"},
"S3DestinationConfiguration":{
"shape":"S3DestinationConfiguration",
"deprecated":true
@@ -206,6 +224,7 @@
"members":{
}
},
"DeliveryStartTimestamp":{"type":"timestamp"},
"DeliveryStreamARN":{
"type":"string",
"max":512,
@@ -218,6 +237,7 @@
"DeliveryStreamName",
"DeliveryStreamARN",
"DeliveryStreamStatus",
"DeliveryStreamType",
"VersionId",
"Destinations",
"HasMoreDestinations"
@@ -226,9 +246,11 @@
"DeliveryStreamName":{"shape":"DeliveryStreamName"},
"DeliveryStreamARN":{"shape":"DeliveryStreamARN"},
"DeliveryStreamStatus":{"shape":"DeliveryStreamStatus"},
"DeliveryStreamType":{"shape":"DeliveryStreamType"},
"VersionId":{"shape":"DeliveryStreamVersionId"},
"CreateTimestamp":{"shape":"Timestamp"},
"LastUpdateTimestamp":{"shape":"Timestamp"},
"Source":{"shape":"SourceDescription"},
"Destinations":{"shape":"DestinationDescriptionList"},
"HasMoreDestinations":{"shape":"BooleanObject"}
}
@@ -251,6 +273,13 @@
"ACTIVE"
]
},
"DeliveryStreamType":{
"type":"string",
"enum":[
"DirectPut",
"KinesisStreamAsSource"
]
},
"DeliveryStreamVersionId":{
"type":"string",
"max":50,
@@ -478,6 +507,21 @@
"S3BackupUpdate":{"shape":"S3DestinationUpdate"}
}
},
"FirehoseSource":{"type":"string"},
"GetKinesisStreamInput":{
"type":"structure",
"required":["DeliveryStreamARN"],
"members":{
"DeliveryStreamARN":{"shape":"DeliveryStreamARN"}
}
},
"GetKinesisStreamOutput":{
"type":"structure",
"members":{
"KinesisStreamARN":{"shape":"KinesisStreamARN"},
"CredentialsForReadingKinesisStream":{"shape":"SessionCredentials"}
}
},
"IntervalInSeconds":{
"type":"integer",
"max":900,
@@ -490,6 +534,14 @@
},
"exception":true
},
"InvalidStreamTypeException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"},
"source":{"shape":"FirehoseSource"}
},
"exception":true
},
"KMSEncryptionConfig":{
"type":"structure",
"required":["AWSKMSKeyARN"],
@@ -497,6 +549,31 @@
"AWSKMSKeyARN":{"shape":"AWSKMSKeyARN"}
}
},
"KinesisStreamARN":{
"type":"string",
"max":512,
"min":1,
"pattern":"arn:.*"
},
"KinesisStreamSourceConfiguration":{
"type":"structure",
"required":[
"KinesisStreamARN",
"RoleARN"
],
"members":{
"KinesisStreamARN":{"shape":"KinesisStreamARN"},
"RoleARN":{"shape":"RoleARN"}
}
},
"KinesisStreamSourceDescription":{
"type":"structure",
"members":{
"KinesisStreamARN":{"shape":"KinesisStreamARN"},
"RoleARN":{"shape":"RoleARN"},
"DeliveryStartTimestamp":{"shape":"DeliveryStartTimestamp"}
}
},
"LimitExceededException":{
"type":"structure",
"members":{
@@ -508,6 +585,7 @@
"type":"structure",
"members":{
"Limit":{"shape":"ListDeliveryStreamsInputLimit"},
"DeliveryStreamType":{"shape":"DeliveryStreamType"},
"ExclusiveStartDeliveryStreamName":{"shape":"DeliveryStreamName"}
}
},
@@ -818,6 +896,7 @@
"CloudWatchLoggingOptions":{"shape":"CloudWatchLoggingOptions"}
}
},
"SecretAccessKey":{"type":"string"},
"ServiceUnavailableException":{
"type":"structure",
"members":{
@@ -826,11 +905,33 @@
"exception":true,
"fault":true
},
"SessionCredentials":{
"type":"structure",
"required":[
"AccessKeyId",
"SecretAccessKey",
"SessionToken",
"Expiration"
],
"members":{
"AccessKeyId":{"shape":"AccessKeyId"},
"SecretAccessKey":{"shape":"SecretAccessKey"},
"SessionToken":{"shape":"SessionToken"},
"Expiration":{"shape":"Timestamp"}
}
},
"SessionToken":{"type":"string"},
"SizeInMBs":{
"type":"integer",
"max":128,
"min":1
},
"SourceDescription":{
"type":"structure",
"members":{
"KinesisStreamSourceDescription":{"shape":"KinesisStreamSourceDescription"}
}
},
"Timestamp":{"type":"timestamp"},
"UpdateDestinationInput":{
"type":"structure",

163
vendor/github.com/aws/aws-sdk-go/models/apis/firehose/2015-08-04/docs-2.json generated vendored
View File

@@ -1,14 +1,15 @@
{
"version": "2.0",
"service": "<fullname>Amazon Kinesis Firehose API Reference</fullname> <p>Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.</p>",
"service": "<fullname>Amazon Kinesis Firehose API Reference</fullname> <p>Amazon Kinesis Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.</p>",
"operations": {
"CreateDeliveryStream": "<p>Creates a delivery stream.</p> <p>By default, you can create up to 20 delivery streams per region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon Elasticsearch Service, or Amazon Redshift. You must specify only one of the following destination configuration parameters: <b>ExtendedS3DestinationConfiguration</b>, <b>S3DestinationConfiguration</b>, <b>ElasticsearchDestinationConfiguration</b>, or <b>RedshiftDestinationConfiguration</b>.</p> <p>When you specify <b>S3DestinationConfiguration</b>, you can also provide the following optional values: <b>BufferingHints</b>, <b>EncryptionConfiguration</b>, and <b>CompressionFormat</b>. By default, if no <b>BufferingHints</b> value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that <b>BufferingHints</b> is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location, as Firehose first delivers data to S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <b>RedshiftDestinationConfiguration.S3Configuration</b> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <b>RedshiftDestinationConfiguration.S3Configuration</b> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"CreateDeliveryStream": "<p>Creates a delivery stream.</p> <p>By default, you can create up to 20 delivery streams per region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>A Kinesis Firehose delivery stream can be configured to receive records directly from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis stream as input, set the <code>DeliveryStreamType</code> parameter to <code>KinesisStreamAsSource</code>, and provide the Kinesis stream ARN and role ARN in the <code>KinesisStreamSourceConfiguration</code> parameter.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES, or Amazon Redshift. You must specify only one of the following destination configuration parameters: <b>ExtendedS3DestinationConfiguration</b>, <b>S3DestinationConfiguration</b>, <b>ElasticsearchDestinationConfiguration</b>, or <b>RedshiftDestinationConfiguration</b>.</p> <p>When you specify <b>S3DestinationConfiguration</b>, you can also provide the following optional values: <b>BufferingHints</b>, <b>EncryptionConfiguration</b>, and <b>CompressionFormat</b>. By default, if no <b>BufferingHints</b> value is provided, Kinesis Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that <b>BufferingHints</b> is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location, as Kinesis Firehose first delivers data to S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <b>RedshiftDestinationConfiguration.S3Configuration</b> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <b>RedshiftDestinationConfiguration.S3Configuration</b> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password you provide exclusively with Kinesis Firehose, and that the permissions for the account are restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Kinesis Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"DeleteDeliveryStream": "<p>Deletes a delivery stream and its data.</p> <p>You can delete a delivery stream only if it is in <code>ACTIVE</code> or <code>DELETING</code> state, and not in the <code>CREATING</code> state. While the deletion request is in process, the delivery stream is in the <code>DELETING</code> state.</p> <p>To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>While the delivery stream is <code>DELETING</code> state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.</p>",
"DescribeDeliveryStream": "<p>Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call <a>DescribeDeliveryStream</a> to see if the delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it.</p>",
"GetKinesisStream": null,
"ListDeliveryStreams": "<p>Lists your delivery streams.</p> <p>The number of delivery streams might be too large to return using a single call to <a>ListDeliveryStreams</a>. You can limit the number of delivery streams returned, using the <b>Limit</b> parameter. To determine whether there are more delivery streams to list, check the value of <b>HasMoreDeliveryStreams</b> in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the <b>ExclusiveStartDeliveryStreamName</b> parameter of a subsequent call.</p>",
"PutRecord": "<p>Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>. </p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc.</p> <p>Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.</p> <p>The <a>PutRecord</a> operation returns a <b>RecordId</b>, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.</p> <p>If the <a>PutRecord</a> operation throws a <b>ServiceUnavailableException</b>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </p> <p>Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"PutRecordBatch": "<p>Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use <a>PutRecord</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>.</p> <p>Each <a>PutRecordBatch</a> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.</p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on.</p> <p>Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.</p> <p>The <a>PutRecordBatch</a> response includes a count of failed records, <b>FailedPutCount</b>, and an array of responses, <b>RequestResponses</b>. Each entry in the <b>RequestResponses</b> array provides additional information about the processed record, and directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. <b>RequestResponses</b> includes both successfully and unsuccessfully processed records. Firehose attempts to process all records in each <a>PutRecordBatch</a> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes a <b>RecordId</b> value, which is unique for the record. An unsuccessfully processed record includes <b>ErrorCode</b> and <b>ErrorMessage</b> values. <b>ErrorCode</b> reflects the type of error, and is one of the following values: <code>ServiceUnavailable</code> or <code>InternalFailure</code>. <b>ErrorMessage</b> provides more detailed information about the error.</p> <p>If there is an internal server error or a timeout, the write might have completed or it might have failed. If <b>FailedPutCount</b> is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.</p> <p>If <a>PutRecordBatch</a> throws <b>ServiceUnavailableException</b>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.</p> <p>Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"UpdateDestination": "<p>Updates the specified destination of the specified delivery stream.</p> <p>You can use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.</p> <p>Note that switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.</p> <p>If the destination type is the same, Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified then the existing <a>EncryptionConfiguration</a> is maintained on the destination.</p> <p>If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified.</p> <p>Firehose uses <b>CurrentDeliveryStreamVersionId</b> to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using <a>DescribeDeliveryStream</a>. You should use the new version ID to set <b>CurrentDeliveryStreamVersionId</b> in the next call.</p>"
"PutRecord": "<p>Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>. </p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <a>PutRecord</a> operation returns a <b>RecordId</b>, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.</p> <p>If the <a>PutRecord</a> operation throws a <b>ServiceUnavailableException</b>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </p> <p>Data records sent to Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"PutRecordBatch": "<p>Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use <a>PutRecord</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>.</p> <p>Each <a>PutRecordBatch</a> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.</p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, web site clickstream data, and so on.</p> <p>Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <a>PutRecordBatch</a> response includes a count of failed records, <b>FailedPutCount</b>, and an array of responses, <b>RequestResponses</b>. Each entry in the <b>RequestResponses</b> array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. <b>RequestResponses</b> includes both successfully and unsuccessfully processed records. Kinesis Firehose attempts to process all records in each <a>PutRecordBatch</a> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes a <b>RecordId</b> value, which is unique for the record. An unsuccessfully processed record includes <b>ErrorCode</b> and <b>ErrorMessage</b> values. <b>ErrorCode</b> reflects the type of error, and is one of the following values: <code>ServiceUnavailable</code> or <code>InternalFailure</code>. <b>ErrorMessage</b> provides more detailed information about the error.</p> <p>If there is an internal server error or a timeout, the write might have completed or it might have failed. If <b>FailedPutCount</b> is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.</p> <p>If <a>PutRecordBatch</a> throws <b>ServiceUnavailableException</b>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.</p> <p>Data records sent to Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"UpdateDestination": "<p>Updates the specified destination of the specified delivery stream.</p> <p>You can use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.</p> <p>Note that switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.</p> <p>If the destination type is the same, Kinesis Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified, then the existing <a>EncryptionConfiguration</a> is maintained on the destination.</p> <p>If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Firehose does not merge any parameters. In this case, all parameters must be specified.</p> <p>Kinesis Firehose uses <b>CurrentDeliveryStreamVersionId</b> to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using <a>DescribeDeliveryStream</a>. Use the new version ID to set <b>CurrentDeliveryStreamVersionId</b> in the next call.</p>"
},
"shapes": {
"AWSKMSKeyARN": {
@@ -17,6 +18,12 @@
"KMSEncryptionConfig$AWSKMSKeyARN": "<p>The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.</p>"
}
},
"AccessKeyId": {
"base": null,
"refs": {
"SessionCredentials$AccessKeyId": null
}
},
"BooleanObject": {
"base": null,
"refs": {
@@ -38,7 +45,7 @@
}
},
"BufferingHints": {
"base": "<p>Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Firehose may choose to use different values when it is optimal.</p>",
"base": "<p>Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Kinesis Firehose may choose to use different values when it is optimal.</p>",
"refs": {
"ExtendedS3DestinationConfiguration$BufferingHints": "<p>The buffering option.</p>",
"ExtendedS3DestinationDescription$BufferingHints": "<p>The buffering option.</p>",
@@ -49,7 +56,7 @@
}
},
"CloudWatchLoggingOptions": {
"base": "<p>Describes the CloudWatch logging options for your delivery stream.</p>",
"base": "<p>Describes the Amazon CloudWatch logging options for your delivery stream.</p>",
"refs": {
"ElasticsearchDestinationConfiguration$CloudWatchLoggingOptions": "<p>The CloudWatch logging options for your delivery stream.</p>",
"ElasticsearchDestinationDescription$CloudWatchLoggingOptions": "<p>The CloudWatch logging options.</p>",
@@ -100,7 +107,7 @@
"CopyOptions": {
"base": null,
"refs": {
"CopyCommand$CopyOptions": "<p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For more information, see the \"Optional Parameters\" section of <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html\">Amazon Redshift COPY command</a>. Some possible examples that would apply to Firehose are as follows:</p> <p> <code>delimiter '\\t' lzop;</code> - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.</p> <p> <code>delimiter '|</code> - fields are delimited with \"|\" (this is the default delimiter).</p> <p> <code>delimiter '|' escape</code> - the delimiter should be escaped.</p> <p> <code>fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'</code> - fields are fixed width in the source, with each width specified after every column in the table.</p> <p> <code>JSON 's3://mybucket/jsonpaths.txt'</code> - data is in JSON format, and the path specified is the format of the data.</p> <p>For more examples, see <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html\">Amazon Redshift COPY command examples</a>.</p>"
"CopyCommand$CopyOptions": "<p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For more information, see the \"Optional Parameters\" section of <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html\">Amazon Redshift COPY command</a>. Some possible examples that would apply to Kinesis Firehose are as follows:</p> <p> <code>delimiter '\\t' lzop;</code> - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.</p> <p> <code>delimiter '|'</code> - fields are delimited with \"|\" (this is the default delimiter).</p> <p> <code>delimiter '|' escape</code> - the delimiter should be escaped.</p> <p> <code>fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'</code> - fields are fixed width in the source, with each width specified after every column in the table.</p> <p> <code>JSON 's3://mybucket/jsonpaths.txt'</code> - data is in JSON format, and the path specified is the format of the data.</p> <p>For more examples, see <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html\">Amazon Redshift COPY command examples</a>.</p>"
}
},
"CreateDeliveryStreamInput": {
@@ -141,11 +148,18 @@
"refs": {
}
},
"DeliveryStartTimestamp": {
"base": null,
"refs": {
"KinesisStreamSourceDescription$DeliveryStartTimestamp": "<p>Kinesis Firehose starts retrieving records from the Kinesis stream starting with this time stamp.</p>"
}
},
"DeliveryStreamARN": {
"base": null,
"refs": {
"CreateDeliveryStreamOutput$DeliveryStreamARN": "<p>The ARN of the delivery stream.</p>",
"DeliveryStreamDescription$DeliveryStreamARN": "<p>The Amazon Resource Name (ARN) of the delivery stream.</p>"
"DeliveryStreamDescription$DeliveryStreamARN": "<p>The Amazon Resource Name (ARN) of the delivery stream.</p>",
"GetKinesisStreamInput$DeliveryStreamARN": null
}
},
"DeliveryStreamDescription": {
@@ -157,7 +171,7 @@
"DeliveryStreamName": {
"base": null,
"refs": {
"CreateDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream. This name must be unique per AWS account in the same region. You can have multiple delivery streams with the same name if they are in different accounts or different regions.</p>",
"CreateDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream. This name must be unique per AWS account in the same region. If the delivery streams are in different accounts or different regions, you can have multiple delivery streams with the same name.</p>",
"DeleteDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"DeliveryStreamDescription$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"DeliveryStreamNameList$member": null,
@@ -180,11 +194,19 @@
"DeliveryStreamDescription$DeliveryStreamStatus": "<p>The status of the delivery stream.</p>"
}
},
"DeliveryStreamType": {
"base": null,
"refs": {
"CreateDeliveryStreamInput$DeliveryStreamType": "<p>The delivery stream type. This parameter can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis stream as a source.</p> </li> </ul>",
"DeliveryStreamDescription$DeliveryStreamType": "<p>The delivery stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis stream as a source.</p> </li> </ul>",
"ListDeliveryStreamsInput$DeliveryStreamType": "<p>The delivery stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis stream as a source.</p> </li> </ul> <p>This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.</p>"
}
},
"DeliveryStreamVersionId": {
"base": null,
"refs": {
"DeliveryStreamDescription$VersionId": "<p>Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.</p>",
"UpdateDestinationInput$CurrentDeliveryStreamVersionId": "<p>Obtain this value from the <b>VersionId</b> result of <a>DeliveryStreamDescription</a>. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the <b>VersionId</b> value is updated. The service then performs a merge of the old configuration with the new configuration.</p>"
"UpdateDestinationInput$CurrentDeliveryStreamVersionId": "<p>Obtain this value from the <b>VersionId</b> result of <a>DeliveryStreamDescription</a>. This value is required, and helps the service to perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the <b>VersionId</b> value is updated. The service then performs a merge of the old configuration with the new configuration.</p>"
}
},
"DescribeDeliveryStreamInput": {
@@ -218,7 +240,7 @@
"DestinationId": {
"base": null,
"refs": {
"DescribeDeliveryStreamInput$ExclusiveStartDestinationId": "<p>The ID of the destination to start returning the destination information. Currently Firehose supports one destination per delivery stream.</p>",
"DescribeDeliveryStreamInput$ExclusiveStartDestinationId": "<p>The ID of the destination to start returning the destination information. Currently, Kinesis Firehose supports one destination per delivery stream.</p>",
"DestinationDescription$DestinationId": "<p>The ID of the destination.</p>",
"UpdateDestinationInput$DestinationId": "<p>The ID of the destination.</p>"
}
@@ -280,29 +302,29 @@
"ElasticsearchIndexRotationPeriod": {
"base": null,
"refs": {
"ElasticsearchDestinationConfiguration$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for Amazon Elasticsearch Service Destination</a>. The default value is <code>OneDay</code>.</p>",
"ElasticsearchDestinationConfiguration$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for Amazon Elasticsearch Service Destination</a>. The default value is <code>OneDay</code>.</p>",
"ElasticsearchDestinationDescription$IndexRotationPeriod": "<p>The Elasticsearch index rotation period</p>",
"ElasticsearchDestinationUpdate$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for Amazon Elasticsearch Service Destination</a>. Default value is <code>OneDay</code>.</p>"
"ElasticsearchDestinationUpdate$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for Amazon Elasticsearch Service Destination</a>. Default value is <code>OneDay</code>.</p>"
}
},
"ElasticsearchRetryDurationInSeconds": {
"base": null,
"refs": {
"ElasticsearchRetryOptions$DurationInSeconds": "<p>After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.</p>"
"ElasticsearchRetryOptions$DurationInSeconds": "<p>After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.</p>"
}
},
"ElasticsearchRetryOptions": {
"base": "<p>Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.</p>",
"base": "<p>Configures retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES.</p>",
"refs": {
"ElasticsearchDestinationConfiguration$RetryOptions": "<p>The retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>",
"ElasticsearchDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>",
"ElasticsearchDestinationDescription$RetryOptions": "<p>The Amazon ES retry options.</p>",
"ElasticsearchDestinationUpdate$RetryOptions": "<p>The retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).</p>"
"ElasticsearchDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>"
}
},
"ElasticsearchS3BackupMode": {
"base": null,
"refs": {
"ElasticsearchDestinationConfiguration$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup\">Amazon S3 Backup for Amazon Elasticsearch Service Destination</a>. Default value is FailedDocumentsOnly.</p>",
"ElasticsearchDestinationConfiguration$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup\">Amazon S3 Backup for Amazon Elasticsearch Service Destination</a>. Default value is FailedDocumentsOnly.</p>",
"ElasticsearchDestinationDescription$S3BackupMode": "<p>The Amazon S3 backup mode.</p>"
}
},
@@ -336,6 +358,7 @@
"refs": {
"ConcurrentModificationException$message": "<p>A message that provides information about the error.</p>",
"InvalidArgumentException$message": "<p>A message that provides information about the error.</p>",
"InvalidStreamTypeException$message": null,
"LimitExceededException$message": "<p>A message that provides information about the error.</p>",
"PutRecordBatchResponseEntry$ErrorMessage": "<p>The error message for an individual record result.</p>",
"ResourceInUseException$message": "<p>A message that provides information about the error.</p>",
@@ -361,6 +384,22 @@
"UpdateDestinationInput$ExtendedS3DestinationUpdate": "<p>Describes an update for a destination in Amazon S3.</p>"
}
},
"FirehoseSource": {
"base": null,
"refs": {
"InvalidStreamTypeException$source": null
}
},
"GetKinesisStreamInput": {
"base": null,
"refs": {
}
},
"GetKinesisStreamOutput": {
"base": null,
"refs": {
}
},
"IntervalInSeconds": {
"base": null,
"refs": {
@@ -368,7 +407,12 @@
}
},
"InvalidArgumentException": {
"base": "<p>The specified input parameter has an value that is not valid.</p>",
"base": "<p>The specified input parameter has a value that is not valid.</p>",
"refs": {
}
},
"InvalidStreamTypeException": {
"base": null,
"refs": {
}
},
@@ -378,6 +422,26 @@
"EncryptionConfiguration$KMSEncryptionConfig": "<p>The encryption key.</p>"
}
},
"KinesisStreamARN": {
"base": null,
"refs": {
"GetKinesisStreamOutput$KinesisStreamARN": null,
"KinesisStreamSourceConfiguration$KinesisStreamARN": "<p>The ARN of the source Kinesis stream.</p>",
"KinesisStreamSourceDescription$KinesisStreamARN": "<p>The ARN of the source Kinesis stream.</p>"
}
},
"KinesisStreamSourceConfiguration": {
"base": "<p>The stream and role ARNs for a Kinesis stream used as the source for a delivery stream.</p>",
"refs": {
"CreateDeliveryStreamInput$KinesisStreamSourceConfiguration": "<p>When a Kinesis stream is used as the source for the delivery stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis stream ARN and the role ARN for the source stream.</p>"
}
},
"KinesisStreamSourceDescription": {
"base": "<p>Details about a Kinesis stream used as the source for a Kinesis Firehose delivery stream.</p>",
"refs": {
"SourceDescription$KinesisStreamSourceDescription": "<p>The <a>KinesisStreamSourceDescription</a> value for the source Kinesis stream.</p>"
}
},
"LimitExceededException": {
"base": "<p>You have already reached the limit for a requested resource.</p>",
"refs": {
@@ -414,7 +478,7 @@
"NoEncryptionConfig": {
"base": null,
"refs": {
"EncryptionConfiguration$NoEncryptionConfig": "<p>Specifically override existing encryption information to ensure no encryption is used.</p>"
"EncryptionConfiguration$NoEncryptionConfig": "<p>Specifically override existing encryption information to ensure that no encryption is used.</p>"
}
},
"NonNegativeIntegerObject": {
@@ -433,12 +497,12 @@
"Prefix": {
"base": null,
"refs": {
"ExtendedS3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>"
"ExtendedS3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>"
}
},
"ProcessingConfiguration": {
@@ -570,15 +634,15 @@
"RedshiftRetryDurationInSeconds": {
"base": null,
"refs": {
"RedshiftRetryOptions$DurationInSeconds": "<p>The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of <code>DurationInSeconds</code> is 0 (zero) or if the first delivery attempt takes longer than the current value.</p>"
"RedshiftRetryOptions$DurationInSeconds": "<p>The length of time during which Kinesis Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Firehose does not retry if the value of <code>DurationInSeconds</code> is 0 (zero) or if the first delivery attempt takes longer than the current value.</p>"
}
},
"RedshiftRetryOptions": {
"base": "<p>Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift.</p>",
"base": "<p>Configures retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift.</p>",
"refs": {
"RedshiftDestinationConfiguration$RetryOptions": "<p>The retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationDescription$RetryOptions": "<p>The retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationUpdate$RetryOptions": "<p>The retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>"
"RedshiftDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationDescription$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>"
}
},
"RedshiftS3BackupMode": {
@@ -602,12 +666,14 @@
"RoleARN": {
"base": null,
"refs": {
"ElasticsearchDestinationConfiguration$RoleARN": "<p>The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a>.</p>",
"ElasticsearchDestinationConfiguration$RoleARN": "<p>The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a>.</p>",
"ElasticsearchDestinationDescription$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"ElasticsearchDestinationUpdate$RoleARN": "<p>The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a>.</p>",
"ElasticsearchDestinationUpdate$RoleARN": "<p>The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a>.</p>",
"ExtendedS3DestinationConfiguration$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"ExtendedS3DestinationDescription$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"ExtendedS3DestinationUpdate$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"KinesisStreamSourceConfiguration$RoleARN": "<p>The ARN of the role that provides access to the source Kinesis stream.</p>",
"KinesisStreamSourceDescription$RoleARN": "<p>The ARN of the role used by the source Kinesis stream.</p>",
"RedshiftDestinationConfiguration$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"RedshiftDestinationDescription$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"RedshiftDestinationUpdate$RoleARN": "<p>The ARN of the AWS credentials.</p>",
@@ -628,7 +694,7 @@
"base": "<p>Describes the configuration of a destination in Amazon S3.</p>",
"refs": {
"CreateDeliveryStreamInput$S3DestinationConfiguration": "<p>[Deprecated] The destination in Amazon S3. You can specify only one destination.</p>",
"ElasticsearchDestinationConfiguration$S3Configuration": "<p>The configuration for the intermediate Amazon S3 location from which Amazon ES obtains data.</p>",
"ElasticsearchDestinationConfiguration$S3Configuration": "<p>The configuration for the backup Amazon S3 location.</p>",
"ExtendedS3DestinationConfiguration$S3BackupConfiguration": "<p>The configuration for backup in Amazon S3.</p>",
"RedshiftDestinationConfiguration$S3Configuration": "<p>The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <b>RedshiftDestinationConfiguration.S3Configuration</b> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>",
"RedshiftDestinationConfiguration$S3BackupConfiguration": "<p>The configuration for backup in Amazon S3.</p>"
@@ -654,22 +720,47 @@
"UpdateDestinationInput$S3DestinationUpdate": "<p>[Deprecated] Describes an update for a destination in Amazon S3.</p>"
}
},
"SecretAccessKey": {
"base": null,
"refs": {
"SessionCredentials$SecretAccessKey": null
}
},
"ServiceUnavailableException": {
"base": "<p>The service is unavailable, back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>.</p>",
"refs": {
}
},
"SessionCredentials": {
"base": null,
"refs": {
"GetKinesisStreamOutput$CredentialsForReadingKinesisStream": null
}
},
"SessionToken": {
"base": null,
"refs": {
"SessionCredentials$SessionToken": null
}
},
"SizeInMBs": {
"base": null,
"refs": {
"BufferingHints$SizeInMBs": "<p>Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.</p> <p>We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.</p>"
}
},
"SourceDescription": {
"base": "<p>Details about a Kinesis stream used as the source for a Kinesis Firehose delivery stream.</p>",
"refs": {
"DeliveryStreamDescription$Source": "<p>If the <code>DeliveryStreamType</code> parameter is <code>KinesisStreamAsSource</code>, a <a>SourceDescription</a> object describing the source Kinesis stream.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"DeliveryStreamDescription$CreateTimestamp": "<p>The date and time that the delivery stream was created.</p>",
"DeliveryStreamDescription$LastUpdateTimestamp": "<p>The date and time that the delivery stream was last updated.</p>"
"DeliveryStreamDescription$LastUpdateTimestamp": "<p>The date and time that the delivery stream was last updated.</p>",
"SessionCredentials$Expiration": null
}
},
"UpdateDestinationInput": {

4
vendor/github.com/aws/aws-sdk-go/models/apis/firehose/2015-08-04/paginators-1.json generated vendored Normal file
View File

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

801
vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/api-2.json generated vendored
View File

File diff suppressed because it is too large Load Diff

693
vendor/github.com/aws/aws-sdk-go/models/apis/gamelift/2015-10-01/docs-2.json generated vendored
View File

File diff suppressed because one or more lines are too long

58
vendor/github.com/aws/aws-sdk-go/models/apis/greengrass/2017-06-07/api-2.json generated vendored
View File

@@ -968,6 +968,23 @@
},
"errors" : [ ]
},
"ResetDeployments" : {
"name" : "ResetDeployments",
"http" : {
"method" : "POST",
"requestUri" : "/greengrass/groups/{GroupId}/deployments/$reset",
"responseCode" : 200
},
"input" : {
"shape" : "ResetDeploymentsRequest"
},
"output" : {
"shape" : "ResetDeploymentsResponse"
},
"errors" : [ {
"shape" : "BadRequestException"
} ]
},
"UpdateConnectivityInfo" : {
"name" : "UpdateConnectivityInfo",
"http" : {
@@ -1873,6 +1890,9 @@
"DeploymentId" : {
"shape" : "__string"
},
"DeploymentType" : {
"shape" : "DeploymentType"
},
"GroupArn" : {
"shape" : "__string"
}
@@ -1880,7 +1900,7 @@
},
"DeploymentType" : {
"type" : "string",
"enum" : [ "NewDeployment", "Redeployment" ]
"enum" : [ "NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment" ]
},
"Deployments" : {
"type" : "list",
@@ -2169,6 +2189,12 @@
"DeploymentStatus" : {
"shape" : "__string"
},
"DeploymentType" : {
"shape" : "DeploymentType"
},
"ErrorDetails" : {
"shape" : "ErrorDetails"
},
"ErrorMessage" : {
"shape" : "__string"
},
@@ -3228,6 +3254,36 @@
"shape" : "__string"
}
},
"ResetDeploymentsRequest" : {
"type" : "structure",
"members" : {
"AmznClientToken" : {
"shape" : "__string",
"location" : "header",
"locationName" : "X-Amzn-Client-Token"
},
"Force" : {
"shape" : "__boolean"
},
"GroupId" : {
"shape" : "__string",
"location" : "uri",
"locationName" : "GroupId"
}
},
"required" : [ "GroupId" ]
},
"ResetDeploymentsResponse" : {
"type" : "structure",
"members" : {
"DeploymentArn" : {
"shape" : "__string"
},
"DeploymentId" : {
"shape" : "__string"
}
}
},
"Subscription" : {
"type" : "structure",
"members" : {

43
vendor/github.com/aws/aws-sdk-go/models/apis/greengrass/2017-06-07/docs-2.json generated vendored
View File

@@ -1,5 +1,5 @@
{
"version" : "1.0",
"version" : "2.0",
"service" : "AWS Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.",
"operations" : {
"AssociateRoleToGroup" : "Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role's permissions will allow Greengrass core Lambda functions to perform actions against the cloud.",
@@ -58,6 +58,7 @@
"ListLoggerDefinitions" : "Retrieves a list of logger definitions.",
"ListSubscriptionDefinitionVersions" : "Lists the versions of a subscription definition.",
"ListSubscriptionDefinitions" : "Retrieves a list of subscription definitions.",
"ResetDeployments" : "Resets a group's deployments.",
"UpdateConnectivityInfo" : "Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it.",
"UpdateCoreDefinition" : "Updates a core definition.",
"UpdateDeviceDefinition" : "Updates a device definition.",
@@ -91,8 +92,8 @@
"ConnectivityInfo" : {
"base" : "Connectivity Info",
"refs" : {
"GetConnectivityInfoResponse$ConnectivityInfo" : "Connectivity info array",
"UpdateConnectivityInfoRequest$ConnectivityInfo" : "Connectivity info array"
"GetConnectivityInfoResponse$ConnectivityInfo" : "Connectivity info list",
"UpdateConnectivityInfoRequest$ConnectivityInfo" : "Connectivity info list"
}
},
"Core" : {
@@ -134,13 +135,15 @@
"DeploymentType" : {
"base" : null,
"refs" : {
"CreateDeploymentRequest$DeploymentType" : "Type of deployment"
"CreateDeploymentRequest$DeploymentType" : "Type of deployment. When used in CreateDeployment, only NewDeployment and Redeployment are valid. ",
"Deployment$DeploymentType" : "The type of deployment.",
"GetDeploymentStatusResponse$DeploymentType" : "The type of the deployment."
}
},
"Deployments" : {
"base" : null,
"refs" : {
"ListDeploymentsResponse$Deployments" : "Information on deployments"
"ListDeploymentsResponse$Deployments" : "List of deployments for the requested groups"
}
},
"Device" : {
@@ -176,7 +179,8 @@
"ErrorDetails" : {
"base" : "Error Details",
"refs" : {
"GeneralError$ErrorDetails" : "Error Details"
"GeneralError$ErrorDetails" : "Error Details",
"GetDeploymentStatusResponse$ErrorDetails" : "The error Details"
}
},
"Function" : {
@@ -262,7 +266,7 @@
"refs" : { }
},
"GroupInformation" : {
"base" : "Information of a group",
"base" : "Information on the group",
"refs" : {
"ListGroupsResponse$Groups" : "Groups"
}
@@ -274,11 +278,11 @@
}
},
"InternalServerErrorException" : {
"base" : "This request was invalid.",
"base" : "Server Error",
"refs" : { }
},
"ListDefinitionsResponse" : {
"base" : "List of definition response",
"base" : "List of definition responses",
"refs" : { }
},
"ListDeploymentsResponse" : {
@@ -371,6 +375,14 @@
"base" : null,
"refs" : { }
},
"ResetDeploymentsRequest" : {
"base" : "Information needed to perform a reset of a group's deployments.",
"refs" : { }
},
"ResetDeploymentsResponse" : {
"base" : null,
"refs" : { }
},
"Subscription" : {
"base" : "Information on subscription",
"refs" : {
@@ -406,7 +418,8 @@
"refs" : {
"Core$SyncShadow" : "If true, the local shadow value automatically syncs with the cloud's shadow state.",
"Device$SyncShadow" : "If true, the local shadow value automatically syncs with the cloud's shadow state.",
"FunctionConfiguration$Pinned" : "Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts."
"FunctionConfiguration$Pinned" : "Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.",
"ResetDeploymentsRequest$Force" : "When set to true, perform a best-effort only core reset."
}
},
"__integer" : {
@@ -433,8 +446,8 @@
"Core$ThingArn" : "Thing arn of the core.",
"CreateDeploymentRequest$DeploymentId" : "Id of the deployment if you wish to redeploy a previous deployment.",
"CreateDeploymentRequest$GroupVersionId" : "Group Version you wish to deploy.",
"CreateDeploymentResponse$DeploymentArn" : "Arn of the deployment.",
"CreateDeploymentResponse$DeploymentId" : "Id of the deployment.",
"CreateDeploymentResponse$DeploymentArn" : "The arn of the deployment.",
"CreateDeploymentResponse$DeploymentId" : "The id of the deployment.",
"CreateGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn" : "Arn of the group certificate authority.",
"DefinitionInformation$Arn" : "Arn of the definition.",
"DefinitionInformation$CreationTimestamp" : "Timestamp of when the definition was created.",
@@ -458,7 +471,7 @@
"Function$Id" : "Id of the function in this version.",
"FunctionConfiguration$ExecArgs" : "Execution Arguments",
"FunctionConfiguration$Executable" : "Executable",
"GeneralError$Message" : "Message",
"GeneralError$Message" : "Message containing information about the error",
"GetAssociatedRoleResponse$AssociatedAt" : "Time when the role was associated for the group.",
"GetAssociatedRoleResponse$RoleArn" : "Arn of the role that is associated with the group.",
"GetConnectivityInfoResponse$message" : "Response Text",
@@ -516,6 +529,8 @@
"ListGroupsResponse$NextToken" : "The token for the next set of results, or ''null'' if there are no additional results.",
"ListVersionsResponse$NextToken" : "The token for the next set of results, or ''null'' if there are no additional results.",
"Logger$Id" : "Element Id for this entry in the list.",
"ResetDeploymentsResponse$DeploymentArn" : "The arn of the reset deployment.",
"ResetDeploymentsResponse$DeploymentId" : "The id of the reset deployment.",
"Subscription$Id" : "Element Id for this entry in the list.",
"Subscription$Source" : "Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'",
"Subscription$Subject" : "Subject of the message.",
@@ -530,4 +545,4 @@
}
}
}
}
}

124
vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/api-2.json generated vendored
View File

@@ -65,6 +65,7 @@
{"shape":"NoSuchEntityException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidInputException"},
{"shape":"PolicyNotAttachableException"},
{"shape":"ServiceFailureException"}
]
},
@@ -80,6 +81,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidInputException"},
{"shape":"UnmodifiableEntityException"},
{"shape":"PolicyNotAttachableException"},
{"shape":"ServiceFailureException"}
]
},
@@ -94,6 +96,7 @@
{"shape":"NoSuchEntityException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidInputException"},
{"shape":"PolicyNotAttachableException"},
{"shape":"ServiceFailureException"}
]
},
@@ -578,6 +581,23 @@
{"shape":"ServiceFailureException"}
]
},
"DeleteServiceLinkedRole":{
"name":"DeleteServiceLinkedRole",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteServiceLinkedRoleRequest"},
"output":{
"shape":"DeleteServiceLinkedRoleResponse",
"resultWrapper":"DeleteServiceLinkedRoleResult"
},
"errors":[
{"shape":"NoSuchEntityException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceFailureException"}
]
},
"DeleteServiceSpecificCredential":{
"name":"DeleteServiceSpecificCredential",
"http":{
@@ -1020,6 +1040,23 @@
{"shape":"ServiceFailureException"}
]
},
"GetServiceLinkedRoleDeletionStatus":{
"name":"GetServiceLinkedRoleDeletionStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetServiceLinkedRoleDeletionStatusRequest"},
"output":{
"shape":"GetServiceLinkedRoleDeletionStatusResponse",
"resultWrapper":"GetServiceLinkedRoleDeletionStatusResult"
},
"errors":[
{"shape":"NoSuchEntityException"},
{"shape":"InvalidInputException"},
{"shape":"ServiceFailureException"}
]
},
"GetUser":{
"name":"GetUser",
"http":{
@@ -1926,6 +1963,10 @@
"UserName":{"shape":"existingUserNameType"}
}
},
"ArnListType":{
"type":"list",
"member":{"shape":"arnType"}
},
"AttachGroupPolicyRequest":{
"type":"structure",
"required":[
@@ -2421,6 +2462,20 @@
"ServerCertificateName":{"shape":"serverCertificateNameType"}
}
},
"DeleteServiceLinkedRoleRequest":{
"type":"structure",
"required":["RoleName"],
"members":{
"RoleName":{"shape":"roleNameType"}
}
},
"DeleteServiceLinkedRoleResponse":{
"type":"structure",
"required":["DeletionTaskId"],
"members":{
"DeletionTaskId":{"shape":"DeletionTaskIdType"}
}
},
"DeleteServiceSpecificCredentialRequest":{
"type":"structure",
"required":["ServiceSpecificCredentialId"],
@@ -2462,6 +2517,27 @@
"SerialNumber":{"shape":"serialNumberType"}
}
},
"DeletionTaskFailureReasonType":{
"type":"structure",
"members":{
"Reason":{"shape":"ReasonType"},
"RoleUsageList":{"shape":"RoleUsageListType"}
}
},
"DeletionTaskIdType":{
"type":"string",
"max":1000,
"min":1
},
"DeletionTaskStatusType":{
"type":"string",
"enum":[
"SUCCEEDED",
"IN_PROGRESS",
"FAILED",
"NOT_STARTED"
]
},
"DetachGroupPolicyRequest":{
"type":"structure",
"required":[
@@ -2887,6 +2963,21 @@
"ServerCertificate":{"shape":"ServerCertificate"}
}
},
"GetServiceLinkedRoleDeletionStatusRequest":{
"type":"structure",
"required":["DeletionTaskId"],
"members":{
"DeletionTaskId":{"shape":"DeletionTaskIdType"}
}
},
"GetServiceLinkedRoleDeletionStatusResponse":{
"type":"structure",
"required":["Status"],
"members":{
"Status":{"shape":"DeletionTaskStatusType"},
"Reason":{"shape":"DeletionTaskFailureReasonType"}
}
},
"GetUserPolicyRequest":{
"type":"structure",
"required":[
@@ -3659,6 +3750,18 @@
"member":{"shape":"PolicyGroup"}
},
"PolicyIdentifierType":{"type":"string"},
"PolicyNotAttachableException":{
"type":"structure",
"members":{
"message":{"shape":"policyNotAttachableMessage"}
},
"error":{
"code":"PolicyNotAttachable",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"PolicyRole":{
"type":"structure",
"members":{
@@ -3748,6 +3851,15 @@
"PolicyDocument":{"shape":"policyDocumentType"}
}
},
"ReasonType":{
"type":"string",
"max":1000
},
"RegionNameType":{
"type":"string",
"max":100,
"min":1
},
"RemoveClientIDFromOpenIDConnectProviderRequest":{
"type":"structure",
"required":[
@@ -3889,6 +4001,17 @@
"AttachedManagedPolicies":{"shape":"attachedPoliciesListType"}
}
},
"RoleUsageListType":{
"type":"list",
"member":{"shape":"RoleUsageType"}
},
"RoleUsageType":{
"type":"structure",
"members":{
"Region":{"shape":"RegionNameType"},
"Resources":{"shape":"ArnListType"}
}
},
"SAMLMetadataDocumentType":{
"type":"string",
"max":10000000,
@@ -4655,6 +4778,7 @@
"min":1,
"pattern":"[\\w+=,.@-]+"
},
"policyNotAttachableMessage":{"type":"string"},
"policyPathType":{
"type":"string",
"pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/"

110
vendor/github.com/aws/aws-sdk-go/models/apis/iam/2010-05-08/docs-2.json generated vendored
View File

@@ -39,6 +39,7 @@
"DeleteSAMLProvider": "<p>Deletes a SAML provider resource in IAM.</p> <p>Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.</p> <note> <p> This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p> </note>",
"DeleteSSHPublicKey": "<p>Deletes the specified SSH public key.</p> <p>The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href=\"http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html\">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>.</p>",
"DeleteServerCertificate": "<p>Deletes the specified server certificate.</p> <p>For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html\">Working with Server Certificates</a> in the <i>IAM User Guide</i>.</p> <important> <p> If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html\">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API Reference</i>.</p> </important>",
"DeleteServiceLinkedRole": "<p>Submits a service-linked role deletion request and returns a <code>DeletionTaskId</code>, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the <code>DeletionTaskId</code> of the earlier request is returned.</p> <p>If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the <a>GetServiceLinkedRoleDeletionStatus</a> API operation returns the reason for the failure, including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the <a href=\"http://docs.aws.amazon.com/\">AWS documentation</a> for your service.</p> <p>For more information about service-linked roles, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role\">Roles Terms and Concepts: AWS Service-Linked Role</a> in the <i>IAM User Guide</i>.</p>",
"DeleteServiceSpecificCredential": "<p>Deletes the specified service-specific credential.</p>",
"DeleteSigningCertificate": "<p>Deletes a signing certificate associated with the specified IAM user.</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. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated IAM users.</p>",
"DeleteUser": "<p>Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.</p>",
@@ -68,6 +69,7 @@
"GetSAMLProvider": "<p>Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.</p> <note> <p>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p> </note>",
"GetSSHPublicKey": "<p>Retrieves the specified SSH public key, including metadata about the key.</p> <p>The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href=\"http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html\">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>.</p>",
"GetServerCertificate": "<p>Retrieves information about the specified server certificate stored in IAM.</p> <p>For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html\">Working with Server Certificates</a> in the <i>IAM User Guide</i>.</p>",
"GetServiceLinkedRoleDeletionStatus": "<p>Retrieves the status of your service-linked role deletion. After you use the <a>DeleteServiceLinkedRole</a> API operation to submit a service-linked role for deletion, you can use the <code>DeletionTaskId</code> parameter in <code>GetServiceLinkedRoleDeletionStatus</code> to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed.</p>",
"GetUser": "<p>Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API.</p>",
"GetUserPolicy": "<p>Retrieves the specified inline policy document that is embedded in the specified IAM user.</p> <note> <p>Policies returned by this API are URL-encoded compliant with <a href=\"https://tools.ietf.org/html/rfc3986\">RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p> </note> <p>An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document.</p> <p>For more information about policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>.</p>",
"ListAccessKeys": "<p>Returns information about the access key IDs associated with the specified IAM user. If there are none, the action returns an empty list.</p> <p>Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p> <p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.</p> <note> <p>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.</p> </note>",
@@ -171,6 +173,12 @@
"refs": {
}
},
"ArnListType": {
"base": null,
"refs": {
"RoleUsageType$Resources": "<p>The name of the resource that is using the service-linked role.</p>"
}
},
"AttachGroupPolicyRequest": {
"base": null,
"refs": {
@@ -486,6 +494,16 @@
"refs": {
}
},
"DeleteServiceLinkedRoleRequest": {
"base": null,
"refs": {
}
},
"DeleteServiceLinkedRoleResponse": {
"base": null,
"refs": {
}
},
"DeleteServiceSpecificCredentialRequest": {
"base": null,
"refs": {
@@ -511,6 +529,25 @@
"refs": {
}
},
"DeletionTaskFailureReasonType": {
"base": "<p>The reason that the service-linked role deletion failed.</p> <p>This data type is used as a response element in the <a>GetServiceLinkedRoleDeletionStatus</a> operation.</p>",
"refs": {
"GetServiceLinkedRoleDeletionStatusResponse$Reason": "<p>An object that contains details about the reason the deletion failed.</p>"
}
},
"DeletionTaskIdType": {
"base": null,
"refs": {
"DeleteServiceLinkedRoleResponse$DeletionTaskId": "<p>The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in the format <code>task/aws-service-role/&lt;service-principal-name&gt;/&lt;role-name&gt;/&lt;task-uuid&gt;</code>.</p>",
"GetServiceLinkedRoleDeletionStatusRequest$DeletionTaskId": "<p>The deletion task identifier. This identifier is returned by the <a>DeleteServiceLinkedRole</a> operation in the format <code>task/aws-service-role/&lt;service-principal-name&gt;/&lt;role-name&gt;/&lt;task-uuid&gt;</code>.</p>"
}
},
"DeletionTaskStatusType": {
"base": null,
"refs": {
"GetServiceLinkedRoleDeletionStatusResponse$Status": "<p>The status of the deletion.</p>"
}
},
"DetachGroupPolicyRequest": {
"base": null,
"refs": {
@@ -758,6 +795,16 @@
"refs": {
}
},
"GetServiceLinkedRoleDeletionStatusRequest": {
"base": null,
"refs": {
}
},
"GetServiceLinkedRoleDeletionStatusResponse": {
"base": null,
"refs": {
}
},
"GetUserPolicyRequest": {
"base": null,
"refs": {
@@ -1190,7 +1237,7 @@
}
},
"PolicyEvaluationException": {
"base": "<p>The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure.</p>",
"base": "<p>The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.</p>",
"refs": {
}
},
@@ -1212,6 +1259,11 @@
"Statement$SourcePolicyId": "<p>The identifier of the policy that was provided as an input.</p>"
}
},
"PolicyNotAttachableException": {
"base": "<p>The request failed because AWS service role policies can only be attached to the service-linked role for that service.</p>",
"refs": {
}
},
"PolicyRole": {
"base": "<p>Contains information about a role that a managed policy is attached to.</p> <p>This data type is used as a response element in the <a>ListEntitiesForPolicy</a> action. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
"refs": {
@@ -1272,6 +1324,18 @@
"refs": {
}
},
"ReasonType": {
"base": null,
"refs": {
"DeletionTaskFailureReasonType$Reason": "<p>A short description of the reason that the service-linked role deletion failed.</p>"
}
},
"RegionNameType": {
"base": null,
"refs": {
"RoleUsageType$Region": "<p>The name of the region where the service-linked role is being used.</p>"
}
},
"RemoveClientIDFromOpenIDConnectProviderRequest": {
"base": null,
"refs": {
@@ -1380,6 +1444,18 @@
"roleDetailListType$member": null
}
},
"RoleUsageListType": {
"base": null,
"refs": {
"DeletionTaskFailureReasonType$RoleUsageList": "<p>A list of objects that contains details about the service-linked role deletion failure. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the region in which the resources are being used.</p>"
}
},
"RoleUsageType": {
"base": "<p>An object that contains details about how a service-linked role is used.</p> <p>This data type is used as a response element in the <a>GetServiceLinkedRoleDeletionStatus</a> operation.</p>",
"refs": {
"RoleUsageListType$member": null
}
},
"SAMLMetadataDocumentType": {
"base": null,
"refs": {
@@ -1694,6 +1770,7 @@
"base": "<p>The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.</p> <p>For more information about ARNs, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>. </p>",
"refs": {
"AddClientIDToOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "<p>The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the <a>ListOpenIDConnectProviders</a> action.</p>",
"ArnListType$member": null,
"AttachGroupPolicyRequest$PolicyArn": "<p>The Amazon Resource Name (ARN) of the IAM policy you want to attach.</p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
"AttachRolePolicyRequest$PolicyArn": "<p>The Amazon Resource Name (ARN) of the IAM policy you want to attach.</p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
"AttachUserPolicyRequest$PolicyArn": "<p>The Amazon Resource Name (ARN) of the IAM policy you want to attach.</p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
@@ -1926,7 +2003,7 @@
"ServiceSpecificCredentialMetadata$CreateDate": "<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the service-specific credential were created.</p>",
"SigningCertificate$UploadDate": "<p>The date when the signing certificate was uploaded.</p>",
"User$CreateDate": "<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the user was created.</p>",
"User$PasswordLastUsed": "<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Credential Reports</a> topic in the <i>Using IAM</i> guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:</p> <ul> <li> <p>The user does not have a password</p> </li> <li> <p>The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014</p> </li> <li> <p>there is no sign-in data associated with the user</p> </li> </ul> <p>This value is returned only in the <a>GetUser</a> and <a>ListUsers</a> actions. </p>",
"User$PasswordLastUsed": "<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Credential Reports</a> topic in the <i>Using IAM</i> guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value) then it indicates that they never signed in with a password. This can be because:</p> <ul> <li> <p>The user never had a password.</p> </li> <li> <p>A password exists but has not been used since IAM started tracking this information on October 20th, 2014.</p> </li> </ul> <p>A null does not mean that the user <i>never</i> had a password. Also, if the user does not currently have a password, but had one in the past, then this field contains the date and time the most recent password was used.</p> <p>This value is returned only in the <a>GetUser</a> and <a>ListUsers</a> actions. </p>",
"UserDetail$CreateDate": "<p>The date and time, in <a href=\"http://www.iso.org/iso/iso8601\">ISO 8601 date-time format</a>, when the user was created.</p>",
"VirtualMFADevice$EnableDate": "<p>The date and time on which the virtual MFA device was enabled.</p>"
}
@@ -2365,7 +2442,7 @@
"policyNameListType": {
"base": "<p>Contains a list of policy names.</p> <p>This data type is used as a response element in the <a>ListPolicies</a> action.</p>",
"refs": {
"ListGroupPoliciesResponse$PolicyNames": "<p>A list of policy names.</p>",
"ListGroupPoliciesResponse$PolicyNames": "<p>A list of policy names.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"ListRolePoliciesResponse$PolicyNames": "<p>A list of policy names.</p>",
"ListUserPoliciesResponse$PolicyNames": "<p>A list of policy names.</p>"
}
@@ -2374,25 +2451,31 @@
"base": null,
"refs": {
"AttachedPolicy$PolicyName": "<p>The friendly name of the attached policy.</p>",
"CreatePolicyRequest$PolicyName": "<p>The friendly name of the policy.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"DeleteGroupPolicyRequest$PolicyName": "<p>The name identifying the policy document to delete.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"DeleteRolePolicyRequest$PolicyName": "<p>The name of the inline policy to delete from the specified IAM role.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"DeleteUserPolicyRequest$PolicyName": "<p>The name identifying the policy document to delete.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"GetGroupPolicyRequest$PolicyName": "<p>The name of the policy document to get.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"CreatePolicyRequest$PolicyName": "<p>The friendly name of the policy.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"DeleteGroupPolicyRequest$PolicyName": "<p>The name identifying the policy document to delete.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"DeleteRolePolicyRequest$PolicyName": "<p>The name of the inline policy to delete from the specified IAM role.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"DeleteUserPolicyRequest$PolicyName": "<p>The name identifying the policy document to delete.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"GetGroupPolicyRequest$PolicyName": "<p>The name of the policy document to get.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"GetGroupPolicyResponse$PolicyName": "<p>The name of the policy.</p>",
"GetRolePolicyRequest$PolicyName": "<p>The name of the policy document to get.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"GetRolePolicyRequest$PolicyName": "<p>The name of the policy document to get.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"GetRolePolicyResponse$PolicyName": "<p>The name of the policy.</p>",
"GetUserPolicyRequest$PolicyName": "<p>The name of the policy document to get.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"GetUserPolicyRequest$PolicyName": "<p>The name of the policy document to get.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"GetUserPolicyResponse$PolicyName": "<p>The name of the policy.</p>",
"ManagedPolicyDetail$PolicyName": "<p>The friendly name (not ARN) identifying the policy.</p>",
"Policy$PolicyName": "<p>The friendly name (not ARN) identifying the policy.</p>",
"PolicyDetail$PolicyName": "<p>The name of the policy.</p>",
"PutGroupPolicyRequest$PolicyName": "<p>The name of the policy document.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"PutRolePolicyRequest$PolicyName": "<p>The name of the policy document.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"PutUserPolicyRequest$PolicyName": "<p>The name of the policy document.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-</p>",
"PutGroupPolicyRequest$PolicyName": "<p>The name of the policy document.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"PutRolePolicyRequest$PolicyName": "<p>The name of the policy document.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"PutUserPolicyRequest$PolicyName": "<p>The name of the policy document.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-+</p>",
"policyNameListType$member": null
}
},
"policyNotAttachableMessage": {
"base": null,
"refs": {
"PolicyNotAttachableException$message": null
}
},
"policyPathType": {
"base": null,
"refs": {
@@ -2481,6 +2564,7 @@
"CreateRoleRequest$RoleName": "<p>The name of the role to create.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p> <p>Role names are not distinguished by case. For example, you cannot create roles named both \"PRODROLE\" and \"prodrole\".</p>",
"DeleteRolePolicyRequest$RoleName": "<p>The name (friendly name, not ARN) identifying the role that the policy is embedded in.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>",
"DeleteRoleRequest$RoleName": "<p>The name of the role to delete.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>",
"DeleteServiceLinkedRoleRequest$RoleName": "<p>The name of the service-linked role to be deleted.</p>",
"DetachRolePolicyRequest$RoleName": "<p>The name (friendly name, not ARN) of the IAM role to detach the policy from.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>",
"GetRolePolicyRequest$RoleName": "<p>The name of the role associated with the policy.</p> <p>This parameter allows (per its <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>",
"GetRolePolicyResponse$RoleName": "<p>The role the policy is associated with.</p>",

13
vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/api-2.json generated vendored
View File

@@ -819,7 +819,8 @@
"FAILED",
"ERROR",
"COMPLETED",
"COMPLETED_WITH_ERRORS"
"COMPLETED_WITH_ERRORS",
"CANCELED"
]
},
"AssessmentRunStateChange":{
@@ -1894,11 +1895,19 @@
"assessmentRunArn":{"shape":"Arn"}
}
},
"StopAction":{
"type":"string",
"enum":[
"START_EVALUATION",
"SKIP_EVALUATION"
]
},
"StopAssessmentRunRequest":{
"type":"structure",
"required":["assessmentRunArn"],
"members":{
"assessmentRunArn":{"shape":"Arn"}
"assessmentRunArn":{"shape":"Arn"},
"stopAction":{"shape":"StopAction"}
}
},
"SubscribeToEventRequest":{

8
vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/docs-2.json generated vendored
View File

@@ -1107,6 +1107,12 @@
"refs": {
}
},
"StopAction": {
"base": null,
"refs": {
"StopAssessmentRunRequest$stopAction": "<p>An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.</p>"
}
},
"StopAssessmentRunRequest": {
"base": null,
"refs": {
@@ -1241,7 +1247,7 @@
"AddAttributesToFindingsRequest$attributes": "<p>The array of attributes that you want to assign to specified findings.</p>",
"AssessmentRun$userAttributesForFindings": "<p>The user-defined attributes that are assigned to every generated finding.</p>",
"AssessmentTemplate$userAttributesForFindings": "<p>The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.</p>",
"CreateAssessmentTemplateRequest$userAttributesForFindings": "<p>The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.</p>",
"CreateAssessmentTemplateRequest$userAttributesForFindings": "<p>The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an <a>Attribute</a> object). Within an assessment template, each key must be unique.</p>",
"Finding$userAttributes": "<p>The user-defined attributes that are assigned to the finding.</p>"
}
},

40
vendor/github.com/aws/aws-sdk-go/models/apis/inspector/2016-02-16/paginators-1.json generated vendored
View File

@@ -1,4 +1,44 @@
{
"pagination": {
"ListAssessmentRunAgents": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListAssessmentRuns": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListAssessmentTargets": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListAssessmentTemplates": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListEventSubscriptions": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListFindings": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListRulesPackages": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"PreviewAgents": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
}
}
}

17
vendor/github.com/aws/aws-sdk-go/models/apis/kinesisanalytics/2015-08-14/api-2.json generated vendored
View File

@@ -40,7 +40,8 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"ConcurrentModificationException"}
{"shape":"ConcurrentModificationException"},
{"shape":"CodeValidationException"}
]
},
"AddApplicationOutput":{
@@ -170,7 +171,8 @@
"errors":[
{"shape":"InvalidArgumentException"},
{"shape":"UnableToDetectSchemaException"},
{"shape":"ResourceProvisionedThroughputExceededException"}
{"shape":"ResourceProvisionedThroughputExceededException"},
{"shape":"ServiceUnavailableException"}
]
},
"ListApplications":{
@@ -666,7 +668,7 @@
},
"InputParallelismCount":{
"type":"integer",
"max":10,
"max":64,
"min":1
},
"InputParallelismUpdate":{
@@ -960,7 +962,7 @@
"RecordColumnMapping":{"type":"string"},
"RecordColumnName":{
"type":"string",
"pattern":"[a-zA-Z][a-zA-Z0-9_]+"
"pattern":"[a-zA-Z_][a-zA-Z0-9_]*"
},
"RecordColumnSqlType":{"type":"string"},
"RecordColumns":{
@@ -1104,6 +1106,13 @@
"ReferenceRoleARNUpdate":{"shape":"RoleARN"}
}
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"SourceSchema":{
"type":"structure",
"required":[

34
vendor/github.com/aws/aws-sdk-go/models/apis/kinesisanalytics/2015-08-14/docs-2.json generated vendored
View File

@@ -2,13 +2,13 @@
"version": "2.0",
"service": null,
"operations": {
"AddApplicationCloudWatchLoggingOption": "<p>Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-monitor-configuration.html\">Monitoring Configuration Errors</a>.</p>",
"AddApplicationCloudWatchLoggingOption": "<p>Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html\">Working with Amazon CloudWatch Logs</a>.</p>",
"AddApplicationInput": "<p> Adds a streaming source to your Amazon Kinesis application. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p> <p>You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see <a>CreateApplication</a>.</p> <p>Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the <a>DescribeApplication</a> operation to find the current application version. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationInput</code> action.</p>",
"AddApplicationOutput": "<p>Adds an external destination to your Amazon Kinesis Analytics application.</p> <p>If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream or a Firehose delivery stream), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.</p> <p> You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Understanding Application Output (Destination)</a>. </p> <p> Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the <a>DescribeApplication</a> operation to find the current application version.</p> <p>For the limits on the number of application inputs and outputs you can configure, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action.</p>",
"AddApplicationReferenceDataSource": "<p>Adds a reference data source to an existing application.</p> <p>Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.</p> <p> For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. For the limits on data sources you can add to your application, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>. </p> <p> This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action. </p>",
"CreateApplication": "<p> Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html\">How it Works</a>. </p> <p>In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.</p> <p>Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.</p> <p>In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.</p> <p> To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the <code>kinesisanalytics:CreateApplication</code> action. </p> <p> For introductory exercises to create an Amazon Kinesis Analytics application, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html\">Getting Started</a>. </p>",
"DeleteApplication": "<p>Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DeleteApplication</code> action.</p>",
"DeleteApplicationCloudWatchLoggingOption": "<p>Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-monitor-configuration.html\">Monitoring Configuration Errors</a>.</p>",
"DeleteApplicationCloudWatchLoggingOption": "<p>Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html\">Working with Amazon CloudWatch Logs</a>.</p>",
"DeleteApplicationOutput": "<p>Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DeleteApplicationOutput</code> action.</p>",
"DeleteApplicationReferenceDataSource": "<p>Deletes a reference data source configuration from the specified application configuration.</p> <p>If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the <a>AddApplicationReferenceDataSource</a> operation. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics.DeleteApplicationReferenceDataSource</code> action.</p>",
"DescribeApplication": "<p>Returns information about a specific Amazon Kinesis Analytics application.</p> <p>If you want to retrieve a list of all applications in your account, use the <a>ListApplications</a> operation.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DescribeApplication</code> action. You can use <code>DescribeApplication</code> to get the current application versionId, which you need to call other operations such as <code>Update</code>. </p>",
@@ -83,14 +83,14 @@
"ApplicationName": {
"base": null,
"refs": {
"AddApplicationCloudWatchLoggingOptionRequest$ApplicationName": "<p>The Amazon Kinesis Analytics application name.</p>",
"AddApplicationCloudWatchLoggingOptionRequest$ApplicationName": "<p>The Kinesis Analytics application name.</p>",
"AddApplicationInputRequest$ApplicationName": "<p>Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.</p>",
"AddApplicationOutputRequest$ApplicationName": "<p>Name of the application to which you want to add the output configuration.</p>",
"AddApplicationReferenceDataSourceRequest$ApplicationName": "<p>Name of an existing application.</p>",
"ApplicationDetail$ApplicationName": "<p>Name of the application.</p>",
"ApplicationSummary$ApplicationName": "<p>Name of the application.</p>",
"CreateApplicationRequest$ApplicationName": "<p>Name of your Amazon Kinesis Analytics application (for example, <code>sample-app</code>).</p>",
"DeleteApplicationCloudWatchLoggingOptionRequest$ApplicationName": "<p>The Amazon Kinesis Analytics application name.</p>",
"DeleteApplicationCloudWatchLoggingOptionRequest$ApplicationName": "<p>The Kinesis Analytics application name.</p>",
"DeleteApplicationOutputRequest$ApplicationName": "<p>Amazon Kinesis Analytics application name.</p>",
"DeleteApplicationReferenceDataSourceRequest$ApplicationName": "<p>Name of an existing application.</p>",
"DeleteApplicationRequest$ApplicationName": "<p>Name of the Amazon Kinesis Analytics application to delete.</p>",
@@ -130,12 +130,12 @@
"ApplicationVersionId": {
"base": null,
"refs": {
"AddApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId": "<p>The version ID of the Amazon Kinesis Analytics application.</p>",
"AddApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId": "<p>The version ID of the Kinesis Analytics application.</p>",
"AddApplicationInputRequest$CurrentApplicationVersionId": "<p>Current version of your Amazon Kinesis Analytics application. You can use the <a>DescribeApplication</a> operation to find the current application version.</p>",
"AddApplicationOutputRequest$CurrentApplicationVersionId": "<p>Version of the application to which you want add the output configuration. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned. </p>",
"AddApplicationReferenceDataSourceRequest$CurrentApplicationVersionId": "<p>Version of the application for which you are adding the reference data source. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>",
"ApplicationDetail$ApplicationVersionId": "<p>Provides the current application version.</p>",
"DeleteApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId": "<p>The version ID of the Amazon Kinesis Analytics application.</p>",
"DeleteApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId": "<p>The version ID of the Kinesis Analytics application.</p>",
"DeleteApplicationOutputRequest$CurrentApplicationVersionId": "<p>Amazon Kinesis Analytics application version. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned. </p>",
"DeleteApplicationReferenceDataSourceRequest$CurrentApplicationVersionId": "<p>Version of the application. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>",
"UpdateApplicationRequest$CurrentApplicationVersionId": "<p>The current application version ID. You can use the <a>DescribeApplication</a> operation to get this value.</p>"
@@ -162,9 +162,9 @@
}
},
"CloudWatchLoggingOption": {
"base": "<p>Provides a description of CloudWatch logging options, including the log stream ARN and the role ARN.</p>",
"base": "<p>Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.</p>",
"refs": {
"AddApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOption": "<p>Provide the CloudWatch log stream ARN and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled. </p>",
"AddApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOption": "<p>Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the <code>PutLogEvents</code> policy action enabled.</p>",
"CloudWatchLoggingOptions$member": null
}
},
@@ -177,7 +177,7 @@
"CloudWatchLoggingOptionDescriptions": {
"base": null,
"refs": {
"ApplicationDetail$CloudWatchLoggingOptionDescriptions": "<p>Describes the CloudWatch log streams configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-monitor-configuration.html\">Monitoring Configuration Errors</a>. </p>"
"ApplicationDetail$CloudWatchLoggingOptionDescriptions": "<p>Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html\">Working with Amazon CloudWatch Logs</a>. </p>"
}
},
"CloudWatchLoggingOptionUpdate": {
@@ -195,7 +195,7 @@
"CloudWatchLoggingOptions": {
"base": null,
"refs": {
"CreateApplicationRequest$CloudWatchLoggingOptions": "<p>Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-monitor-configuration.html\">Monitoring Configuration Errors</a>.</p>"
"CreateApplicationRequest$CloudWatchLoggingOptions": "<p>Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html\">Working with Amazon CloudWatch Logs</a>.</p>"
}
},
"CodeValidationException": {
@@ -297,6 +297,7 @@
"ResourceInUseException$message": "<p/>",
"ResourceNotFoundException$message": "<p/>",
"ResourceProvisionedThroughputExceededException$message": null,
"ServiceUnavailableException$message": null,
"UnableToDetectSchemaException$message": null
}
},
@@ -459,7 +460,7 @@
"KinesisFirehoseInput": {
"base": "<p> Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>",
"refs": {
"Input$KinesisFirehoseInput": "<p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the Firehose delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
"Input$KinesisFirehoseInput": "<p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the Firehose delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p> <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>"
}
},
"KinesisFirehoseInputDescription": {
@@ -495,7 +496,7 @@
"KinesisStreamsInput": {
"base": "<p> Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>",
"refs": {
"Input$KinesisStreamsInput": "<p>If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
"Input$KinesisStreamsInput": "<p>If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p> <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>"
}
},
"KinesisStreamsInputDescription": {
@@ -698,7 +699,7 @@
"RecordRowPath": {
"base": null,
"refs": {
"JSONMappingParameters$RecordRowPath": "<p>Path to the top-level parent that contains the records.</p> <p>For example, consider the following JSON record:</p> <p>In the <code>RecordRowPath</code>, <code>\"$\"</code> refers to the root and path <code>\"$.vehicle.Model\"</code> refers to the specific <code>\"Model\"</code> key in the JSON.</p>"
"JSONMappingParameters$RecordRowPath": "<p>Path to the top-level parent that contains the records.</p>"
}
},
"ReferenceDataSource": {
@@ -769,7 +770,7 @@
"RoleARN": {
"base": null,
"refs": {
"CloudWatchLoggingOption$RoleARN": "<p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>",
"CloudWatchLoggingOption$RoleARN": "<p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the <code>PutLogEvents</code> policy action enabled.</p>",
"CloudWatchLoggingOptionDescription$RoleARN": "<p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>",
"CloudWatchLoggingOptionUpdate$RoleARNUpdate": "<p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>",
"DiscoverInputSchemaRequest$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.</p>",
@@ -808,6 +809,11 @@
"ReferenceDataSourceUpdate$S3ReferenceDataSourceUpdate": "<p>Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.</p>"
}
},
"ServiceUnavailableException": {
"base": "<p>The service is unavailable, back off and retry the operation. </p>",
"refs": {
}
},
"SourceSchema": {
"base": "<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.</p>",
"refs": {

110
vendor/github.com/aws/aws-sdk-go/models/apis/lex-models/2017-04-19/api-2.json generated vendored
View File

@@ -371,6 +371,22 @@
{"shape":"BadRequestException"}
]
},
"GetExport":{
"name":"GetExport",
"http":{
"method":"GET",
"requestUri":"/exports/",
"responseCode":200
},
"input":{"shape":"GetExportRequest"},
"output":{"shape":"GetExportResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"BadRequestException"}
]
},
"GetIntent":{
"name":"GetIntent",
"http":{
@@ -677,7 +693,8 @@
"key":{"shape":"String"},
"value":{"shape":"String"},
"max":10,
"min":1
"min":1,
"sensitive":true
},
"ChannelType":{
"type":"string",
@@ -804,7 +821,8 @@
"lastUpdatedDate":{"shape":"Timestamp"},
"createdDate":{"shape":"Timestamp"},
"version":{"shape":"Version"},
"checksum":{"shape":"String"}
"checksum":{"shape":"String"},
"valueSelectionStrategy":{"shape":"SlotValueSelectionStrategy"}
}
},
"CustomOrBuiltinSlotTypeName":{
@@ -975,7 +993,8 @@
"type":"structure",
"required":["value"],
"members":{
"value":{"shape":"Value"}
"value":{"shape":"Value"},
"synonyms":{"shape":"SynonymList"}
}
},
"EnumerationValues":{
@@ -984,6 +1003,18 @@
"max":10000,
"min":1
},
"ExportStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"READY",
"FAILED"
]
},
"ExportType":{
"type":"string",
"enum":["ALEXA_SKILLS_KIT"]
},
"FollowUpPrompt":{
"type":"structure",
"required":[
@@ -1329,6 +1360,49 @@
"nextToken":{"shape":"NextToken"}
}
},
"GetExportRequest":{
"type":"structure",
"required":[
"name",
"version",
"resourceType",
"exportType"
],
"members":{
"name":{
"shape":"Name",
"location":"querystring",
"locationName":"name"
},
"version":{
"shape":"NumericalVersion",
"location":"querystring",
"locationName":"version"
},
"resourceType":{
"shape":"ResourceType",
"location":"querystring",
"locationName":"resourceType"
},
"exportType":{
"shape":"ExportType",
"location":"querystring",
"locationName":"exportType"
}
}
},
"GetExportResponse":{
"type":"structure",
"members":{
"name":{"shape":"Name"},
"version":{"shape":"NumericalVersion"},
"resourceType":{"shape":"ResourceType"},
"exportType":{"shape":"ExportType"},
"exportStatus":{"shape":"ExportStatus"},
"failureReason":{"shape":"String"},
"url":{"shape":"String"}
}
},
"GetIntentRequest":{
"type":"structure",
"required":[
@@ -1451,7 +1525,8 @@
"lastUpdatedDate":{"shape":"Timestamp"},
"createdDate":{"shape":"Timestamp"},
"version":{"shape":"Version"},
"checksum":{"shape":"String"}
"checksum":{"shape":"String"},
"valueSelectionStrategy":{"shape":"SlotValueSelectionStrategy"}
}
},
"GetSlotTypeVersionsRequest":{
@@ -1554,9 +1629,7 @@
},
"IntentList":{
"type":"list",
"member":{"shape":"Intent"},
"max":100,
"min":1
"member":{"shape":"Intent"}
},
"IntentMetadata":{
"type":"structure",
@@ -1660,7 +1733,7 @@
"type":"string",
"max":64,
"min":1,
"pattern":"[a-zA-Z]+"
"pattern":"[a-zA-Z_]+"
},
"NextToken":{"type":"string"},
"NotFoundException":{
@@ -1847,7 +1920,8 @@
},
"description":{"shape":"Description"},
"enumerationValues":{"shape":"EnumerationValues"},
"checksum":{"shape":"String"}
"checksum":{"shape":"String"},
"valueSelectionStrategy":{"shape":"SlotValueSelectionStrategy"}
}
},
"PutSlotTypeResponse":{
@@ -1859,7 +1933,8 @@
"lastUpdatedDate":{"shape":"Timestamp"},
"createdDate":{"shape":"Timestamp"},
"version":{"shape":"Version"},
"checksum":{"shape":"String"}
"checksum":{"shape":"String"},
"valueSelectionStrategy":{"shape":"SlotValueSelectionStrategy"}
}
},
"ReferenceType":{
@@ -1887,6 +1962,10 @@
"version":{"shape":"Version"}
}
},
"ResourceType":{
"type":"string",
"enum":["BOT"]
},
"ResponseCard":{
"type":"string",
"max":50000,
@@ -1960,6 +2039,13 @@
"max":10,
"min":0
},
"SlotValueSelectionStrategy":{
"type":"string",
"enum":[
"ORIGINAL_VALUE",
"TOP_RESOLUTION"
]
},
"Statement":{
"type":"structure",
"required":["messages"],
@@ -1985,6 +2071,10 @@
]
},
"String":{"type":"string"},
"SynonymList":{
"type":"list",
"member":{"shape":"Value"}
},
"Timestamp":{"type":"timestamp"},
"UserId":{
"type":"string",

65
vendor/github.com/aws/aws-sdk-go/models/apis/lex-models/2017-04-19/docs-2.json generated vendored
View File

@@ -14,7 +14,7 @@
"DeleteSlotType": "<p>Deletes all versions of the slot type, including the <code>$LATEST</code> version. To delete a specific version of the slot type, use the <a>DeleteSlotTypeVersion</a> operation.</p> <p> You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. </p> <note> <p> If you get the <code>ResourceInUseException</code> exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the <code>DeleteSlotType</code> call is successful. </p> </note> <p>This operation requires permission for the <code>lex:DeleteSlotType</code> action.</p>",
"DeleteSlotTypeVersion": "<p>Deletes a specific version of a slot type. To delete all versions of a slot type, use the <a>DeleteSlotType</a> operation. </p> <p>This operation requires permissions for the <code>lex:DeleteSlotTypeVersion</code> action.</p>",
"DeleteUtterances": "<p>Deletes stored utterances.</p> <p>Amazon Lex stores the utterances that users send to your bot unless the <code>childDirected</code> field in the bot is set to <code>true</code>. Utterances are stored for 15 days for use with the <a>GetUtterancesView</a> operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.</p> <p>Use the <code>DeleteStoredUtterances</code> operation to manually delete stored utterances for a specific user.</p> <p>This operation requires permissions for the <code>lex:DeleteUtterances</code> action.</p>",
"GetBot": "<p>Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. </p> <p> The GetBot operation requires permissions for the <code>lex:GetBot</code> action. </p>",
"GetBot": "<p>Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. </p> <p> This operation requires permissions for the <code>lex:GetBot</code> action. </p>",
"GetBotAlias": "<p>Returns information about an Amazon Lex bot alias. For more information about aliases, see <a>versioning-aliases</a>.</p> <p>This operation requires permissions for the <code>lex:GetBotAlias</code> action.</p>",
"GetBotAliases": "<p>Returns a list of aliases for a specified Amazon Lex bot.</p> <p>This operation requires permissions for the <code>lex:GetBotAliases</code> action.</p>",
"GetBotChannelAssociation": "<p>Returns information about the association between an Amazon Lex bot and a messaging platform.</p> <p>This operation requires permissions for the <code>lex:GetBotChannelAssociation</code> action.</p>",
@@ -24,6 +24,7 @@
"GetBuiltinIntent": "<p>Returns information about a built-in intent.</p> <p>This operation requires permission for the <code>lex:GetBuiltinIntent</code> action.</p>",
"GetBuiltinIntents": "<p>Gets a list of built-in intents that meet the specified criteria.</p> <p>This operation requires permission for the <code>lex:GetBuiltinIntents</code> action.</p>",
"GetBuiltinSlotTypes": "<p>Gets a list of built-in slot types that meet the specified criteria.</p> <p>For a list of built-in slot types, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference\">Slot Type Reference</a> in the <i>Alexa Skills Kit</i>.</p> <p>This operation requires permission for the <code>lex:GetBuiltInSlotTypes</code> action.</p>",
"GetExport": "<p>Exports the contents of a Amazon Lex resource in a specified format. </p>",
"GetIntent": "<p> Returns information about an intent. In addition to the intent name, you must specify the intent version. </p> <p> This operation requires permissions to perform the <code>lex:GetIntent</code> action. </p>",
"GetIntentVersions": "<p>Gets information about all of the versions of an intent.</p> <p>The <code>GetIntentVersions</code> operation returns an <code>IntentMetadata</code> object for each version of an intent. For example, if an intent has three numbered versions, the <code>GetIntentVersions</code> operation returns four <code>IntentMetadata</code> objects in the response, one for each numbered version and one for the <code>$LATEST</code> version. </p> <p>The <code>GetIntentVersions</code> operation always returns at least one version, the <code>$LATEST</code> version.</p> <p>This operation requires permissions for the <code>lex:GetIntentVersions</code> action.</p>",
"GetIntents": "<p>Returns intent information as follows: </p> <ul> <li> <p>If you specify the <code>nameContains</code> field, returns the <code>$LATEST</code> version of all intents that contain the specified string.</p> </li> <li> <p> If you don't specify the <code>nameContains</code> field, returns information about the <code>$LATEST</code> version of all intents. </p> </li> </ul> <p> The operation requires permission for the <code>lex:GetIntents</code> action. </p>",
@@ -378,10 +379,23 @@
"refs": {
"CreateSlotTypeVersionResponse$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take.</p>",
"GetSlotTypeResponse$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take.</p>",
"PutSlotTypeRequest$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take.</p>",
"PutSlotTypeRequest$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take. Each value can have a list of <code>synonyms</code>, which are additional values that help train the machine learning model about the values that it resolves for a slot. </p> <p>When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The <code>valueSelectionStrategy</code> field indicates the option to use. </p>",
"PutSlotTypeResponse$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take.</p>"
}
},
"ExportStatus": {
"base": null,
"refs": {
"GetExportResponse$exportStatus": "<p>The status of the export. </p> <ul> <li> <p> <code>IN_PROGRESS</code> - The export is in progress.</p> </li> <li> <p> <code>READY</code> - The export is complete.</p> </li> <li> <p> <code>FAILED</code> - The export could not be completed.</p> </li> </ul>"
}
},
"ExportType": {
"base": null,
"refs": {
"GetExportRequest$exportType": "<p>The format of the exported data.</p>",
"GetExportResponse$exportType": "<p>The format of the exported data.</p>"
}
},
"FollowUpPrompt": {
"base": "<p>A prompt for additional activity after an intent is fulfilled. For example, after the <code>OrderPizza</code> intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.</p>",
"refs": {
@@ -396,7 +410,7 @@
"refs": {
"CreateIntentVersionResponse$fulfillmentActivity": "<p> Describes how the intent is fulfilled. </p>",
"GetIntentResponse$fulfillmentActivity": "<p>Describes how the intent is fulfilled. For more information, see <a>PutIntent</a>. </p>",
"PutIntentRequest$fulfillmentActivity": "<p> Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, <code>fulfillmentActivity</code> defines how the bot places an order with a local pizza store. </p> <p> You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). </p>",
"PutIntentRequest$fulfillmentActivity": "<p>Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, <code>fulfillmentActivity</code> defines how the bot places an order with a local pizza store. </p> <p> You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). </p>",
"PutIntentResponse$fulfillmentActivity": "<p>If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.</p>"
}
},
@@ -506,6 +520,16 @@
"refs": {
}
},
"GetExportRequest": {
"base": null,
"refs": {
}
},
"GetExportResponse": {
"base": null,
"refs": {
}
},
"GetIntentRequest": {
"base": null,
"refs": {
@@ -715,6 +739,8 @@
"Name": {
"base": null,
"refs": {
"GetExportRequest$name": "<p>The name of the bot to export.</p>",
"GetExportResponse$name": "<p>The name of the bot being exported.</p>",
"ResourceReference$name": "<p>The name of the resource that is using the resource that you are trying to delete.</p>"
}
},
@@ -753,7 +779,9 @@
"refs": {
"DeleteBotVersionRequest$version": "<p>The version of the bot to delete. You cannot delete the <code>$LATEST</code> version of the bot. To delete the <code>$LATEST</code> version, use the <a>DeleteBot</a> operation.</p>",
"DeleteIntentVersionRequest$version": "<p>The version of the intent to delete. You cannot delete the <code>$LATEST</code> version of the intent. To delete the <code>$LATEST</code> version, use the <a>DeleteIntent</a> operation.</p>",
"DeleteSlotTypeVersionRequest$version": "<p>The version of the slot type to delete. You cannot delete the <code>$LATEST</code> version of the slot type. To delete the <code>$LATEST</code> version, use the <a>DeleteSlotType</a> operation.</p>"
"DeleteSlotTypeVersionRequest$version": "<p>The version of the slot type to delete. You cannot delete the <code>$LATEST</code> version of the slot type. To delete the <code>$LATEST</code> version, use the <a>DeleteSlotType</a> operation.</p>",
"GetExportRequest$version": "<p>The version of the bot to export.</p>",
"GetExportResponse$version": "<p>The version of the bot being exported.</p>"
}
},
"PreconditionFailedException": {
@@ -851,6 +879,13 @@
"ResourceInUseException$exampleReference": null
}
},
"ResourceType": {
"base": null,
"refs": {
"GetExportRequest$resourceType": "<p>The type of resource to export. </p>",
"GetExportResponse$resourceType": "<p>The type of the exported resource.</p>"
}
},
"ResponseCard": {
"base": null,
"refs": {
@@ -885,7 +920,7 @@
"refs": {
"CreateIntentVersionResponse$slots": "<p>An array of slot types that defines the information required to fulfill the intent.</p>",
"GetIntentResponse$slots": "<p>An array of intent slots configured for the intent.</p>",
"PutIntentRequest$slots": "<p>An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see &lt;xref linkend=\"how-it-works\"/&gt;. </p>",
"PutIntentRequest$slots": "<p>An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see <a>how-it-works</a>. </p>",
"PutIntentResponse$slots": "<p>An array of intent slots that are configured for the intent.</p>"
}
},
@@ -930,6 +965,15 @@
"Slot$sampleUtterances": "<p> If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances. </p>"
}
},
"SlotValueSelectionStrategy": {
"base": null,
"refs": {
"CreateSlotTypeVersionResponse$valueSelectionStrategy": "<p>The strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>",
"GetSlotTypeResponse$valueSelectionStrategy": "<p>The strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>",
"PutSlotTypeRequest$valueSelectionStrategy": "<p>Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:</p> <ul> <li> <p> <code>ORIGINAL_VALUE</code> - Returns the value entered by the user, if the user value is similar to the slot value.</p> </li> <li> <p> <code>TOP_RESOLUTION</code> - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.</p> </li> </ul> <p>If you don't specify the <code>valueSelectionStrategy</code>, the default is <code>ORIGINAL_VALUE</code>.</p>",
"PutSlotTypeResponse$valueSelectionStrategy": "<p>The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>"
}
},
"Statement": {
"base": "<p>A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey. </p>",
"refs": {
@@ -987,6 +1031,8 @@
"GetBotResponse$checksum": "<p>Checksum of the bot used to identify a specific revision of the bot's <code>$LATEST</code> version.</p>",
"GetBuiltinIntentsRequest$signatureContains": "<p>Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\" To find the signature for an intent, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents\">Standard Built-in Intents</a> in the <i>Alexa Skills Kit</i>.</p>",
"GetBuiltinSlotTypesRequest$signatureContains": "<p>Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"</p>",
"GetExportResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to export the resource.</p>",
"GetExportResponse$url": "<p>An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.</p>",
"GetIntentResponse$checksum": "<p>Checksum of the intent.</p>",
"GetSlotTypeResponse$checksum": "<p>Checksum of the <code>$LATEST</code> version of the slot type.</p>",
"InternalFailureException$message": null,
@@ -1007,6 +1053,12 @@
"PutSlotTypeResponse$checksum": "<p>Checksum of the <code>$LATEST</code> version of the slot type.</p>"
}
},
"SynonymList": {
"base": null,
"refs": {
"EnumerationValue$synonyms": "<p>Additional values related to the slot type value.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
@@ -1080,7 +1132,8 @@
"Value": {
"base": null,
"refs": {
"EnumerationValue$value": "<p>The value of the slot type.</p>"
"EnumerationValue$value": "<p>The value of the slot type.</p>",
"SynonymList$member": null
}
},
"Version": {

145
vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/api-2.json generated vendored
View File

@@ -11,6 +11,20 @@
"uid":"logs-2014-03-28"
},
"operations":{
"AssociateKmsKey":{
"name":"AssociateKmsKey",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateKmsKeyRequest"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OperationAbortedException"},
{"shape":"ServiceUnavailableException"}
]
},
"CancelExportTask":{
"name":"CancelExportTask",
"http":{
@@ -127,6 +141,19 @@
{"shape":"ServiceUnavailableException"}
]
},
"DeleteResourcePolicy":{
"name":"DeleteResourcePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteResourcePolicyRequest"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceUnavailableException"}
]
},
"DeleteRetentionPolicy":{
"name":"DeleteRetentionPolicy",
"http":{
@@ -222,6 +249,19 @@
{"shape":"ServiceUnavailableException"}
]
},
"DescribeResourcePolicies":{
"name":"DescribeResourcePolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeResourcePoliciesRequest"},
"output":{"shape":"DescribeResourcePoliciesResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ServiceUnavailableException"}
]
},
"DescribeSubscriptionFilters":{
"name":"DescribeSubscriptionFilters",
"http":{
@@ -236,6 +276,20 @@
{"shape":"ServiceUnavailableException"}
]
},
"DisassociateKmsKey":{
"name":"DisassociateKmsKey",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateKmsKeyRequest"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OperationAbortedException"},
{"shape":"ServiceUnavailableException"}
]
},
"FilterLogEvents":{
"name":"FilterLogEvents",
"http":{
@@ -335,6 +389,20 @@
{"shape":"ServiceUnavailableException"}
]
},
"PutResourcePolicy":{
"name":"PutResourcePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutResourcePolicyRequest"},
"output":{"shape":"PutResourcePolicyResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceUnavailableException"}
]
},
"PutRetentionPolicy":{
"name":"PutRetentionPolicy",
"http":{
@@ -407,6 +475,17 @@
"min":1
},
"Arn":{"type":"string"},
"AssociateKmsKeyRequest":{
"type":"structure",
"required":[
"logGroupName",
"kmsKeyId"
],
"members":{
"logGroupName":{"shape":"LogGroupName"},
"kmsKeyId":{"shape":"KmsKeyId"}
}
},
"CancelExportTaskRequest":{
"type":"structure",
"required":["taskId"],
@@ -443,6 +522,7 @@
"required":["logGroupName"],
"members":{
"logGroupName":{"shape":"LogGroupName"},
"kmsKeyId":{"shape":"KmsKeyId"},
"tags":{"shape":"Tags"}
}
},
@@ -502,6 +582,12 @@
"filterName":{"shape":"FilterName"}
}
},
"DeleteResourcePolicyRequest":{
"type":"structure",
"members":{
"policyName":{"shape":"PolicyName"}
}
},
"DeleteRetentionPolicyRequest":{
"type":"structure",
"required":["logGroupName"],
@@ -609,6 +695,20 @@
"nextToken":{"shape":"NextToken"}
}
},
"DescribeResourcePoliciesRequest":{
"type":"structure",
"members":{
"nextToken":{"shape":"NextToken"},
"limit":{"shape":"DescribeLimit"}
}
},
"DescribeResourcePoliciesResponse":{
"type":"structure",
"members":{
"resourcePolicies":{"shape":"ResourcePolicies"},
"nextToken":{"shape":"NextToken"}
}
},
"DescribeSubscriptionFiltersRequest":{
"type":"structure",
"required":["logGroupName"],
@@ -651,6 +751,13 @@
"type":"list",
"member":{"shape":"Destination"}
},
"DisassociateKmsKeyRequest":{
"type":"structure",
"required":["logGroupName"],
"members":{
"logGroupName":{"shape":"LogGroupName"}
}
},
"Distribution":{
"type":"string",
"enum":[
@@ -849,6 +956,10 @@
},
"exception":true
},
"KmsKeyId":{
"type":"string",
"max":256
},
"LimitExceededException":{
"type":"structure",
"members":{
@@ -877,7 +988,8 @@
"retentionInDays":{"shape":"Days"},
"metricFilterCount":{"shape":"FilterCount"},
"arn":{"shape":"Arn"},
"storedBytes":{"shape":"StoredBytes"}
"storedBytes":{"shape":"StoredBytes"},
"kmsKeyId":{"shape":"KmsKeyId"}
}
},
"LogGroupName":{
@@ -1003,6 +1115,12 @@
"type":"list",
"member":{"shape":"OutputLogEvent"}
},
"PolicyDocument":{
"type":"string",
"max":5120,
"min":1
},
"PolicyName":{"type":"string"},
"PutDestinationPolicyRequest":{
"type":"structure",
"required":[
@@ -1069,6 +1187,19 @@
"metricTransformations":{"shape":"MetricTransformations"}
}
},
"PutResourcePolicyRequest":{
"type":"structure",
"members":{
"policyName":{"shape":"PolicyName"},
"policyDocument":{"shape":"PolicyDocument"}
}
},
"PutResourcePolicyResponse":{
"type":"structure",
"members":{
"resourcePolicy":{"shape":"ResourcePolicy"}
}
},
"PutRetentionPolicyRequest":{
"type":"structure",
"required":[
@@ -1117,6 +1248,18 @@
},
"exception":true
},
"ResourcePolicies":{
"type":"list",
"member":{"shape":"ResourcePolicy"}
},
"ResourcePolicy":{
"type":"structure",
"members":{
"policyName":{"shape":"PolicyName"},
"policyDocument":{"shape":"PolicyDocument"},
"lastUpdatedTime":{"shape":"Timestamp"}
}
},
"RoleArn":{
"type":"string",
"min":1

186
vendor/github.com/aws/aws-sdk-go/models/apis/logs/2014-03-28/docs-2.json generated vendored
View File

@@ -1,32 +1,37 @@
{
"version": "2.0",
"service": "<p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.</p> <p>You can use CloudWatch Logs to:</p> <ul> <li> <p> <b>Monitor Logs from Amazon EC2 Instances in Real-time</b>: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\") or count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.</p> </li> <li> <p> <b>Monitor Amazon CloudTrail Logged Events</b>: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.</p> </li> <li> <p> <b>Archive Log Data</b>: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.</p> </li> </ul>",
"service": "<p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.</p> <p>You can use CloudWatch Logs to:</p> <ul> <li> <p> <b>Monitor logs from EC2 instances in real-time</b>: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\") or count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.</p> </li> <li> <p> <b>Monitor AWS CloudTrail logged events</b>: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.</p> </li> <li> <p> <b>Archive log data</b>: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.</p> </li> </ul>",
"operations": {
"AssociateKmsKey": "<p>Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.</p> <p>Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p> <p>Note that it can take up to 5 minutes for this operation to take effect.</p> <p>If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an <code>InvalidParameterException</code> error. </p>",
"CancelExportTask": "<p>Cancels the specified export task.</p> <p>The task must be in the <code>PENDING</code> or <code>RUNNING</code> state.</p>",
"CreateExportTask": "<p>Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.</p> <p>This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use <a>DescribeExportTasks</a> to get the status of the export task. Each account can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time. To cancel an export task, use <a>CancelExportTask</a>.</p> <p>You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.</p>",
"CreateLogGroup": "<p>Creates a log group with the specified name.</p> <p>You can create up to 5000 log groups per account.</p> <p>You must use the following guidelines when naming a log group:</p> <ul> <li> <p>Log group names must be unique within a region for an AWS account.</p> </li> <li> <p>Log group names can be between 1 and 512 characters long.</p> </li> <li> <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</p> </li> </ul>",
"CreateExportTask": "<p>Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.</p> <p>This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use <a>DescribeExportTasks</a> to get the status of the export task. Each account can only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time. To cancel an export task, use <a>CancelExportTask</a>.</p> <p>You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.</p>",
"CreateLogGroup": "<p>Creates a log group with the specified name.</p> <p>You can create up to 5000 log groups per account.</p> <p>You must use the following guidelines when naming a log group:</p> <ul> <li> <p>Log group names must be unique within a region for an AWS account.</p> </li> <li> <p>Log group names can be between 1 and 512 characters long.</p> </li> <li> <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</p> </li> </ul> <p>If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.</p> <p>If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an <code>InvalidParameterException</code> error. </p>",
"CreateLogStream": "<p>Creates a log stream for the specified log group.</p> <p>There is no limit on the number of log streams that you can create for a log group.</p> <p>You must use the following guidelines when naming a log stream:</p> <ul> <li> <p>Log stream names must be unique within the log group.</p> </li> <li> <p>Log stream names can be between 1 and 512 characters long.</p> </li> <li> <p>The ':' (colon) and '*' (asterisk) characters are not allowed.</p> </li> </ul>",
"DeleteDestination": "<p>Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.</p>",
"DeleteLogGroup": "<p>Deletes the specified log group and permanently deletes all the archived log events associated with the log group.</p>",
"DeleteLogStream": "<p>Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.</p>",
"DeleteMetricFilter": "<p>Deletes the specified metric filter.</p>",
"DeleteResourcePolicy": "<p>Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.</p>",
"DeleteRetentionPolicy": "<p>Deletes the specified retention policy.</p> <p>Log events do not expire if they belong to log groups without a retention policy.</p>",
"DeleteSubscriptionFilter": "<p>Deletes the specified subscription filter.</p>",
"DescribeDestinations": "<p>Lists all your destinations. The results are ASCII-sorted by destination name.</p>",
"DescribeExportTasks": "<p>Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.</p>",
"DescribeLogGroups": "<p>Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.</p>",
"DescribeLogStreams": "<p>Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.</p> <p>This operation has a limit of five transactions per second, after which transactions are throttled.</p>",
"DescribeMetricFilters": "<p>Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, and metric namespace. The results are ASCII-sorted by filter name.</p>",
"DescribeMetricFilters": "<p>Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.</p>",
"DescribeResourcePolicies": "<p>Lists the resource policies in this account.</p>",
"DescribeSubscriptionFilters": "<p>Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.</p>",
"FilterLogEvents": "<p>Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.</p> <p>By default, this operation returns as many log events as can fit in 1MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.</p>",
"GetLogEvents": "<p>Lists log events from the specified log stream. You can list all the log events or filter using a time range.</p> <p>By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). If the results include tokens, there are more log events available. You can get additional log events by specifying one of the tokens in a subsequent call.</p>",
"ListTagsLogGroup": "<p>Lists the tags for the specified log group.</p> <p>To add tags, use <a>TagLogGroup</a>. To remove tags, use <a>UntagLogGroup</a>.</p>",
"PutDestination": "<p>Creates or updates a destination. A destination encapsulates a physical resource (such as a Kinesis stream) and enables you to subscribe to a real-time stream of log events of a different account, ingested using <a>PutLogEvents</a>. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.</p> <p>A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, <code>PutDestination</code> does not set any access policy with the destination, which means a cross-account user cannot call <a>PutSubscriptionFilter</a> against this destination. To enable this, the destination owner must call <a>PutDestinationPolicy</a> after <code>PutDestination</code>.</p>",
"DisassociateKmsKey": "<p>Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.</p> <p>After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.</p> <p>Note that it can take up to 5 minutes for this operation to take effect.</p>",
"FilterLogEvents": "<p>Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.</p> <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.</p>",
"GetLogEvents": "<p>Lists log events from the specified log stream. You can list all the log events or filter using a time range.</p> <p>By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.</p>",
"ListTagsLogGroup": "<p>Lists the tags for the specified log group.</p>",
"PutDestination": "<p>Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using <a>PutLogEvents</a>. Currently, the only supported physical resource is a Kinesis stream belonging to the same account as the destination.</p> <p>Through an access policy, a destination controls what is written to its Kinesis stream. By default, <code>PutDestination</code> does not set any access policy with the destination, which means a cross-account user cannot call <a>PutSubscriptionFilter</a> against this destination. To enable this, the destination owner must call <a>PutDestinationPolicy</a> after <code>PutDestination</code>.</p>",
"PutDestinationPolicy": "<p>Creates or updates an access policy associated with an existing destination. An access policy is an <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html\">IAM policy document</a> that is used to authorize claims to register a subscription filter against a given destination.</p>",
"PutLogEvents": "<p>Uploads a batch of log events to the specified log stream.</p> <p>You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using <a>DescribeLogStreams</a>.</p> <p>The batch of events must satisfy the following constraints:</p> <ul> <li> <p>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</p> </li> <li> <p>None of the log events in the batch can be more than 2 hours in the future.</p> </li> <li> <p>None of the log events in the batch can be older than 14 days or the retention period of the log group.</p> </li> <li> <p>The log events in the batch must be in chronological ordered by their timestamp (the time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC).</p> </li> <li> <p>The maximum number of log events in a batch is 10,000.</p> </li> <li> <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p> </li> </ul>",
"PutLogEvents": "<p>Uploads a batch of log events to the specified log stream.</p> <p>You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using <a>DescribeLogStreams</a>. If you call <code>PutLogEvents</code> twice within a narrow time period using the same value for <code>sequenceToken</code>, both calls may be successful, or one may be rejected.</p> <p>The batch of events must satisfy the following constraints:</p> <ul> <li> <p>The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.</p> </li> <li> <p>None of the log events in the batch can be more than 2 hours in the future.</p> </li> <li> <p>None of the log events in the batch can be older than 14 days or the retention period of the log group.</p> </li> <li> <p>The log events in the batch must be in chronological ordered by their time stamp (the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC).</p> </li> <li> <p>The maximum number of log events in a batch is 10,000.</p> </li> <li> <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p> </li> </ul>",
"PutMetricFilter": "<p>Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through <a>PutLogEvents</a>.</p> <p>The maximum number of metric filters that can be associated with a log group is 100.</p>",
"PutRetentionPolicy": "<p>Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.</p>",
"PutSubscriptionFilter": "<p>Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <a>PutLogEvents</a> and have them delivered to a specific destination. Currently, the supported destinations are:</p> <ul> <li> <p>An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>A logical destination that belongs to a different account, for cross-account delivery.</p> </li> <li> <p>An Amazon Kinesis Firehose stream that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> </ul> <p>There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in <code>filterName</code>. Otherwise, the call will fail because you cannot associate a second filter with a log group.</p>",
"PutResourcePolicy": "<p>Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 50 resource policies per region.</p>",
"PutRetentionPolicy": "<p>Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.</p>",
"PutSubscriptionFilter": "<p>Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through <a>PutLogEvents</a> and have them delivered to a specific destination. Currently, the supported destinations are:</p> <ul> <li> <p>An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>A logical destination that belongs to a different account, for cross-account delivery.</p> </li> <li> <p>An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.</p> </li> </ul> <p>There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in <code>filterName</code>. Otherwise, the call fails because you cannot associate a second filter with a log group.</p>",
"TagLogGroup": "<p>Adds or updates the specified tags for the specified log group.</p> <p>To list the tags for a log group, use <a>ListTagsLogGroup</a>. To remove tags, use <a>UntagLogGroup</a>.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/log-group-tagging.html\">Tag Log Groups in Amazon CloudWatch Logs</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>",
"TestMetricFilter": "<p>Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.</p>",
"UntagLogGroup": "<p>Removes the specified tags from the specified log group.</p> <p>To list the tags for a log group, use <a>ListTagsLogGroup</a>. To add tags, use <a>UntagLogGroup</a>.</p>"
@@ -47,6 +52,11 @@
"LogStream$arn": "<p>The Amazon Resource Name (ARN) of the log stream.</p>"
}
},
"AssociateKmsKeyRequest": {
"base": null,
"refs": {
}
},
"CancelExportTaskRequest": {
"base": null,
"refs": {
@@ -110,6 +120,11 @@
"refs": {
}
},
"DeleteResourcePolicyRequest": {
"base": null,
"refs": {
}
},
"DeleteRetentionPolicyRequest": {
"base": null,
"refs": {
@@ -154,6 +169,7 @@
"DescribeLogGroupsRequest$limit": "<p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>",
"DescribeLogStreamsRequest$limit": "<p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>",
"DescribeMetricFiltersRequest$limit": "<p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>",
"DescribeResourcePoliciesRequest$limit": "<p>The maximum number of resource policies to be displayed with one call of this API.</p>",
"DescribeSubscriptionFiltersRequest$limit": "<p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>"
}
},
@@ -187,6 +203,16 @@
"refs": {
}
},
"DescribeResourcePoliciesRequest": {
"base": null,
"refs": {
}
},
"DescribeResourcePoliciesResponse": {
"base": null,
"refs": {
}
},
"DescribeSubscriptionFiltersRequest": {
"base": null,
"refs": {
@@ -207,7 +233,7 @@
"DestinationArn": {
"base": null,
"refs": {
"PutSubscriptionFilterRequest$destinationArn": "<p>The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:</p> <ul> <li> <p>An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.</p> </li> <li> <p>An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.</p> </li> </ul>",
"PutSubscriptionFilterRequest$destinationArn": "<p>The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:</p> <ul> <li> <p>An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.</p> </li> <li> <p>An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.</p> </li> <li> <p>An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.</p> </li> </ul>",
"SubscriptionFilter$destinationArn": "<p>The Amazon Resource Name (ARN) of the destination.</p>"
}
},
@@ -227,11 +253,16 @@
"DescribeDestinationsResponse$destinations": "<p>The destinations.</p>"
}
},
"Distribution": {
"DisassociateKmsKeyRequest": {
"base": null,
"refs": {
"PutSubscriptionFilterRequest$distribution": "<p>The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream. By default, log data is grouped by log stream. For a more even distribution, you can group log data randomly.</p>",
"SubscriptionFilter$distribution": "<p>The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream.</p>"
}
},
"Distribution": {
"base": "<p>The method used to distribute log data to the destination, which can be either random or grouped by log stream.</p>",
"refs": {
"PutSubscriptionFilterRequest$distribution": "<p>The method used to distribute log data to the destination. By default log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream. </p>",
"SubscriptionFilter$distribution": null
}
},
"EventId": {
@@ -260,7 +291,7 @@
"base": null,
"refs": {
"FilterLogEventsRequest$limit": "<p>The maximum number of events to return. The default is 10,000 events.</p>",
"GetLogEventsRequest$limit": "<p>The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1MB, up to 10,000 log events.</p>"
"GetLogEventsRequest$limit": "<p>The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.</p>"
}
},
"ExportDestinationBucket": {
@@ -361,12 +392,12 @@
"DescribeSubscriptionFiltersRequest$filterNamePrefix": "<p>The prefix to match. If you don't specify a value, no prefix filter is applied.</p>",
"MetricFilter$filterName": "<p>The name of the metric filter.</p>",
"PutMetricFilterRequest$filterName": "<p>A name for the metric filter.</p>",
"PutSubscriptionFilterRequest$filterName": "<p>A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in <code>filterName</code>. Otherwise, the call will fail because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use <a>DescribeSubscriptionFilters</a>.</p>",
"PutSubscriptionFilterRequest$filterName": "<p>A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in <code>filterName</code>. Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use <a>DescribeSubscriptionFilters</a>.</p>",
"SubscriptionFilter$filterName": "<p>The name of the subscription filter.</p>"
}
},
"FilterPattern": {
"base": "<p>A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.</p>",
"base": "<p>A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain time stamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.</p>",
"refs": {
"FilterLogEventsRequest$filterPattern": "<p>The filter pattern to use. If not provided, all the events are matched.</p>",
"MetricFilter$filterPattern": null,
@@ -419,7 +450,7 @@
"Interleaved": {
"base": null,
"refs": {
"FilterLogEventsRequest$interleaved": "<p>If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If the value is false all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.</p>"
"FilterLogEventsRequest$interleaved": "<p>If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.</p>"
}
},
"InvalidOperationException": {
@@ -437,6 +468,14 @@
"refs": {
}
},
"KmsKeyId": {
"base": null,
"refs": {
"AssociateKmsKeyRequest$kmsKeyId": "<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - AWS Key Management Service (AWS KMS)</a>.</p>",
"CreateLogGroupRequest$kmsKeyId": "<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">Amazon Resource Names - AWS Key Management Service (AWS KMS)</a>.</p>",
"LogGroup$kmsKeyId": "<p>The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.</p>"
}
},
"LimitExceededException": {
"base": "<p>You have reached the maximum number of resources that can be created.</p>",
"refs": {
@@ -469,6 +508,7 @@
"LogGroupName": {
"base": null,
"refs": {
"AssociateKmsKeyRequest$logGroupName": "<p>The name of the log group.</p>",
"CreateExportTaskRequest$logGroupName": "<p>The name of the log group.</p>",
"CreateLogGroupRequest$logGroupName": "<p>The name of the log group.</p>",
"CreateLogStreamRequest$logGroupName": "<p>The name of the log group.</p>",
@@ -481,6 +521,7 @@
"DescribeLogStreamsRequest$logGroupName": "<p>The name of the log group.</p>",
"DescribeMetricFiltersRequest$logGroupName": "<p>The name of the log group.</p>",
"DescribeSubscriptionFiltersRequest$logGroupName": "<p>The name of the log group.</p>",
"DisassociateKmsKeyRequest$logGroupName": "<p>The name of the log group.</p>",
"ExportTask$logGroupName": "<p>The name of the log group from which logs data was exported.</p>",
"FilterLogEventsRequest$logGroupName": "<p>The name of the log group.</p>",
"GetLogEventsRequest$logGroupName": "<p>The name of the log group.</p>",
@@ -514,7 +555,7 @@
"CreateExportTaskRequest$logStreamNamePrefix": "<p>Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.</p>",
"CreateLogStreamRequest$logStreamName": "<p>The name of the log stream.</p>",
"DeleteLogStreamRequest$logStreamName": "<p>The name of the log stream.</p>",
"DescribeLogStreamsRequest$logStreamNamePrefix": "<p>The prefix to match.</p> <p>You cannot specify this parameter if <code>orderBy</code> is <code>LastEventTime</code>.</p>",
"DescribeLogStreamsRequest$logStreamNamePrefix": "<p>The prefix to match.</p> <p>iIf <code>orderBy</code> is <code>LastEventTime</code>,you cannot specify this parameter.</p>",
"FilteredLogEvent$logStreamName": "<p>The name of the log stream this event belongs to.</p>",
"GetLogEventsRequest$logStreamName": "<p>The name of the log stream.</p>",
"InputLogStreamNames$member": null,
@@ -562,7 +603,7 @@
"MetricName": {
"base": "<p>The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount.</p>",
"refs": {
"DescribeMetricFiltersRequest$metricName": "<p>The name of the CloudWatch metric.</p>",
"DescribeMetricFiltersRequest$metricName": null,
"MetricTransformation$metricName": "<p>The name of the CloudWatch metric.</p>"
}
},
@@ -574,7 +615,7 @@
}
},
"MetricTransformation": {
"base": "<p>Indicates how to transform ingested log events into metric data in a CloudWatch metric.</p>",
"base": "<p>Indicates how to transform ingested log events in to metric data in a CloudWatch metric.</p>",
"refs": {
"MetricTransformations$member": null
}
@@ -583,7 +624,7 @@
"base": null,
"refs": {
"MetricFilter$metricTransformations": "<p>The metric transformations.</p>",
"PutMetricFilterRequest$metricTransformations": "<p>A collection of information needed to define how metric data gets emitted.</p>"
"PutMetricFilterRequest$metricTransformations": "<p>A collection of information that defines how metric data gets emitted.</p>"
}
},
"MetricValue": {
@@ -605,6 +646,8 @@
"DescribeLogStreamsResponse$nextToken": null,
"DescribeMetricFiltersRequest$nextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>",
"DescribeMetricFiltersResponse$nextToken": null,
"DescribeResourcePoliciesRequest$nextToken": null,
"DescribeResourcePoliciesResponse$nextToken": null,
"DescribeSubscriptionFiltersRequest$nextToken": "<p>The token for the next set of items to return. (You received this token from a previous call.)</p>",
"DescribeSubscriptionFiltersResponse$nextToken": null,
"FilterLogEventsRequest$nextToken": "<p>The token for the next set of events to return. (You received this token from a previous call.)</p>",
@@ -622,7 +665,7 @@
"OrderBy": {
"base": null,
"refs": {
"DescribeLogStreamsRequest$orderBy": "<p>If the value is <code>LogStreamName</code>, the results are ordered by log stream name. If the value is <code>LastEventTime</code>, the results are ordered by the event time. The default value is <code>LogStreamName</code>.</p> <p>If you order the results by event time, you cannot specify the <code>logStreamNamePrefix</code> parameter.</p> <p>lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.</p>"
"DescribeLogStreamsRequest$orderBy": "<p>If the value is <code>LogStreamName</code>, the results are ordered by log stream name. If the value is <code>LastEventTime</code>, the results are ordered by the event time. The default value is <code>LogStreamName</code>.</p> <p>If you order the results by event time, you cannot specify the <code>logStreamNamePrefix</code> parameter.</p> <p>lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.</p>"
}
},
"OutputLogEvent": {
@@ -637,6 +680,21 @@
"GetLogEventsResponse$events": "<p>The events.</p>"
}
},
"PolicyDocument": {
"base": null,
"refs": {
"PutResourcePolicyRequest$policyDocument": "<p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.</p> <p>The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.</p> <p> { \"Version\": \"2012-10-17\" \"Statement\": [ { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\":\"logs:PutLogEvents\", \"Resource\": logArn } ] } </p>",
"ResourcePolicy$policyDocument": "<p>The details of the policy.</p>"
}
},
"PolicyName": {
"base": null,
"refs": {
"DeleteResourcePolicyRequest$policyName": "<p>The name of the policy to be revoked. This parameter is required.</p>",
"PutResourcePolicyRequest$policyName": "<p>Name of the new policy. This parameter is required.</p>",
"ResourcePolicy$policyName": "<p>The name of the resource policy.</p>"
}
},
"PutDestinationPolicyRequest": {
"base": null,
"refs": {
@@ -667,6 +725,16 @@
"refs": {
}
},
"PutResourcePolicyRequest": {
"base": null,
"refs": {
}
},
"PutResourcePolicyResponse": {
"base": null,
"refs": {
}
},
"PutRetentionPolicyRequest": {
"base": null,
"refs": {
@@ -693,11 +761,24 @@
"refs": {
}
},
"ResourcePolicies": {
"base": null,
"refs": {
"DescribeResourcePoliciesResponse$resourcePolicies": "<p>The resource policies that exist in this account.</p>"
}
},
"ResourcePolicy": {
"base": "<p>A policy enabling one or more entities to put logs to a log group in this account.</p>",
"refs": {
"PutResourcePolicyResponse$resourcePolicy": "<p>The new policy.</p>",
"ResourcePolicies$member": null
}
},
"RoleArn": {
"base": null,
"refs": {
"Destination$roleArn": "<p>A role for impersonation, used when delivering log events to the target.</p>",
"PutDestinationRequest$roleArn": "<p>The ARN of an IAM role that grants CloudWatch Logs permissions to call Amazon Kinesis PutRecord on the destination stream.</p>",
"PutDestinationRequest$roleArn": "<p>The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.</p>",
"PutSubscriptionFilterRequest$roleArn": "<p>The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.</p>",
"SubscriptionFilter$roleArn": "<p/>"
}
@@ -720,7 +801,7 @@
"DataAlreadyAcceptedException$expectedSequenceToken": null,
"InvalidSequenceTokenException$expectedSequenceToken": null,
"LogStream$uploadSequenceToken": "<p>The sequence token.</p>",
"PutLogEventsRequest$sequenceToken": "<p>The sequence token.</p>",
"PutLogEventsRequest$sequenceToken": "<p>The sequence token obtained from the response of the previous <code>PutLogEvents</code> call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using <a>DescribeLogStreams</a>. If you call <code>PutLogEvents</code> twice within a narrow time period using the same value for <code>sequenceToken</code>, both calls may be successful, or one may be rejected.</p>",
"PutLogEventsResponse$nextSequenceToken": "<p>The next sequence token.</p>"
}
},
@@ -782,15 +863,15 @@
"base": null,
"refs": {
"CreateLogGroupRequest$tags": "<p>The key-value pairs to use for the tags.</p>",
"ListTagsLogGroupResponse$tags": "<p>The tags.</p>",
"ListTagsLogGroupResponse$tags": "<p>The tags for the log group.</p>",
"TagLogGroupRequest$tags": "<p>The key-value pairs to use for the tags.</p>"
}
},
"TargetArn": {
"base": null,
"refs": {
"Destination$targetArn": "<p>The Amazon Resource Name (ARN) of the physical target where the log events will be delivered (for example, a Kinesis stream).</p>",
"PutDestinationRequest$targetArn": "<p>The ARN of an Amazon Kinesis stream to deliver matching log events to.</p>"
"Destination$targetArn": "<p>The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream).</p>",
"PutDestinationRequest$targetArn": "<p>The ARN of an Amazon Kinesis stream to which to deliver matching log events.</p>"
}
},
"TestEventMessages": {
@@ -812,29 +893,30 @@
"Timestamp": {
"base": null,
"refs": {
"CreateExportTaskRequest$from": "<p>The start time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.</p>",
"CreateExportTaskRequest$to": "<p>The end time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.</p>",
"Destination$creationTime": "<p>The creation time of the destination, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"ExportTask$from": "<p>The start time, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not exported.</p>",
"ExportTask$to": "<p>The end time, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.</p>",
"ExportTaskExecutionInfo$creationTime": "<p>The creation time of the export task, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"ExportTaskExecutionInfo$completionTime": "<p>The completion time of the export task, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"FilterLogEventsRequest$startTime": "<p>The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not returned.</p>",
"FilterLogEventsRequest$endTime": "<p>The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.</p>",
"FilteredLogEvent$timestamp": "<p>The time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"FilteredLogEvent$ingestionTime": "<p>The time the event was ingested, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"GetLogEventsRequest$startTime": "<p>The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not included.</p>",
"GetLogEventsRequest$endTime": "<p>The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not included.</p>",
"InputLogEvent$timestamp": "<p>The time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"LogGroup$creationTime": "<p>The creation time of the log group, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"LogStream$creationTime": "<p>The creation time of the stream, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"LogStream$firstEventTimestamp": "<p>The time of the first event, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"LogStream$lastEventTimestamp": "<p> the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. lastEventTime updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.</p>",
"LogStream$lastIngestionTime": "<p>The ingestion time, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"MetricFilter$creationTime": "<p>The creation time of the metric filter, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"OutputLogEvent$timestamp": "<p>The time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"OutputLogEvent$ingestionTime": "<p>The time the event was ingested, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
"SubscriptionFilter$creationTime": "<p>The creation time of the subscription filter, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>"
"CreateExportTaskRequest$from": "<p>The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.</p>",
"CreateExportTaskRequest$to": "<p>The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.</p>",
"Destination$creationTime": "<p>The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"ExportTask$from": "<p>The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not exported.</p>",
"ExportTask$to": "<p>The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.</p>",
"ExportTaskExecutionInfo$creationTime": "<p>The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"ExportTaskExecutionInfo$completionTime": "<p>The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"FilterLogEventsRequest$startTime": "<p>The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.</p>",
"FilterLogEventsRequest$endTime": "<p>The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.</p>",
"FilteredLogEvent$timestamp": "<p>The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"FilteredLogEvent$ingestionTime": "<p>The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"GetLogEventsRequest$startTime": "<p>The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not included.</p>",
"GetLogEventsRequest$endTime": "<p>The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not included.</p>",
"InputLogEvent$timestamp": "<p>The time the event occurred, expressed as the number of milliseconds fter Jan 1, 1970 00:00:00 UTC.</p>",
"LogGroup$creationTime": "<p>The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"LogStream$creationTime": "<p>The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"LogStream$firstEventTimestamp": "<p>The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"LogStream$lastEventTimestamp": "<p> the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTime updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.</p>",
"LogStream$lastIngestionTime": "<p>The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"MetricFilter$creationTime": "<p>The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"OutputLogEvent$timestamp": "<p>The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"OutputLogEvent$ingestionTime": "<p>The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"ResourcePolicy$lastUpdatedTime": "<p>Time stamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>",
"SubscriptionFilter$creationTime": "<p>The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.</p>"
}
},
"Token": {

839
vendor/github.com/aws/aws-sdk-go/models/apis/mgh/2017-05-31/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,839 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-05-31",
"endpointPrefix":"mgh",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Migration Hub",
"signatureVersion":"v4",
"targetPrefix":"AWSMigrationHub",
"uid":"AWSMigrationHub-2017-05-31"
},
"operations":{
"AssociateCreatedArtifact":{
"name":"AssociateCreatedArtifact",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateCreatedArtifactRequest"},
"output":{"shape":"AssociateCreatedArtifactResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"AssociateDiscoveredResource":{
"name":"AssociateDiscoveredResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateDiscoveredResourceRequest"},
"output":{"shape":"AssociateDiscoveredResourceResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"PolicyErrorException"},
{"shape":"ResourceNotFoundException"}
]
},
"CreateProgressUpdateStream":{
"name":"CreateProgressUpdateStream",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateProgressUpdateStreamRequest"},
"output":{"shape":"CreateProgressUpdateStreamResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"}
]
},
"DeleteProgressUpdateStream":{
"name":"DeleteProgressUpdateStream",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteProgressUpdateStreamRequest"},
"output":{"shape":"DeleteProgressUpdateStreamResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"DescribeApplicationState":{
"name":"DescribeApplicationState",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeApplicationStateRequest"},
"output":{"shape":"DescribeApplicationStateResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
{"shape":"PolicyErrorException"},
{"shape":"ResourceNotFoundException"}
]
},
"DescribeMigrationTask":{
"name":"DescribeMigrationTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeMigrationTaskRequest"},
"output":{"shape":"DescribeMigrationTaskResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"DisassociateCreatedArtifact":{
"name":"DisassociateCreatedArtifact",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateCreatedArtifactRequest"},
"output":{"shape":"DisassociateCreatedArtifactResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"DisassociateDiscoveredResource":{
"name":"DisassociateDiscoveredResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateDiscoveredResourceRequest"},
"output":{"shape":"DisassociateDiscoveredResourceResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"ImportMigrationTask":{
"name":"ImportMigrationTask",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportMigrationTaskRequest"},
"output":{"shape":"ImportMigrationTaskResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"ListCreatedArtifacts":{
"name":"ListCreatedArtifacts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCreatedArtifactsRequest"},
"output":{"shape":"ListCreatedArtifactsResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"ListDiscoveredResources":{
"name":"ListDiscoveredResources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDiscoveredResourcesRequest"},
"output":{"shape":"ListDiscoveredResourcesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"ListMigrationTasks":{
"name":"ListMigrationTasks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListMigrationTasksRequest"},
"output":{"shape":"ListMigrationTasksResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"},
{"shape":"PolicyErrorException"},
{"shape":"ResourceNotFoundException"}
]
},
"ListProgressUpdateStreams":{
"name":"ListProgressUpdateStreams",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListProgressUpdateStreamsRequest"},
"output":{"shape":"ListProgressUpdateStreamsResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidInputException"}
]
},
"NotifyApplicationState":{
"name":"NotifyApplicationState",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"NotifyApplicationStateRequest"},
"output":{"shape":"NotifyApplicationStateResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"PolicyErrorException"},
{"shape":"ResourceNotFoundException"}
]
},
"NotifyMigrationTaskState":{
"name":"NotifyMigrationTaskState",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"NotifyMigrationTaskStateRequest"},
"output":{"shape":"NotifyMigrationTaskStateResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"PutResourceAttributes":{
"name":"PutResourceAttributes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutResourceAttributesRequest"},
"output":{"shape":"PutResourceAttributesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerError"},
{"shape":"ServiceUnavailableException"},
{"shape":"DryRunOperation"},
{"shape":"UnauthorizedOperation"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ApplicationId":{
"type":"string",
"max":1600,
"min":1
},
"ApplicationStatus":{
"type":"string",
"enum":[
"NOT_STARTED",
"IN_PROGRESS",
"COMPLETED"
]
},
"AssociateCreatedArtifactRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName",
"CreatedArtifact"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"CreatedArtifact":{"shape":"CreatedArtifact"},
"DryRun":{"shape":"DryRun"}
}
},
"AssociateCreatedArtifactResult":{
"type":"structure",
"members":{
}
},
"AssociateDiscoveredResourceRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName",
"DiscoveredResource"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"DiscoveredResource":{"shape":"DiscoveredResource"},
"DryRun":{"shape":"DryRun"}
}
},
"AssociateDiscoveredResourceResult":{
"type":"structure",
"members":{
}
},
"ConfigurationId":{
"type":"string",
"min":1
},
"CreateProgressUpdateStreamRequest":{
"type":"structure",
"required":["ProgressUpdateStreamName"],
"members":{
"ProgressUpdateStreamName":{"shape":"ProgressUpdateStream"},
"DryRun":{"shape":"DryRun"}
}
},
"CreateProgressUpdateStreamResult":{
"type":"structure",
"members":{
}
},
"CreatedArtifact":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"CreatedArtifactName"},
"Description":{"shape":"CreatedArtifactDescription"}
}
},
"CreatedArtifactDescription":{
"type":"string",
"max":500,
"min":0
},
"CreatedArtifactList":{
"type":"list",
"member":{"shape":"CreatedArtifact"}
},
"CreatedArtifactName":{
"type":"string",
"max":1600,
"min":1,
"pattern":"arn:[a-z-]+:[a-z0-9-]+:(?:[a-z0-9-]+|):(?:[0-9]{12}|):.*"
},
"DeleteProgressUpdateStreamRequest":{
"type":"structure",
"required":["ProgressUpdateStreamName"],
"members":{
"ProgressUpdateStreamName":{"shape":"ProgressUpdateStream"},
"DryRun":{"shape":"DryRun"}
}
},
"DeleteProgressUpdateStreamResult":{
"type":"structure",
"members":{
}
},
"DescribeApplicationStateRequest":{
"type":"structure",
"required":["ApplicationId"],
"members":{
"ApplicationId":{"shape":"ApplicationId"}
}
},
"DescribeApplicationStateResult":{
"type":"structure",
"members":{
"ApplicationStatus":{"shape":"ApplicationStatus"},
"LastUpdatedTime":{"shape":"UpdateDateTime"}
}
},
"DescribeMigrationTaskRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"}
}
},
"DescribeMigrationTaskResult":{
"type":"structure",
"members":{
"MigrationTask":{"shape":"MigrationTask"}
}
},
"DisassociateCreatedArtifactRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName",
"CreatedArtifactName"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"CreatedArtifactName":{"shape":"CreatedArtifactName"},
"DryRun":{"shape":"DryRun"}
}
},
"DisassociateCreatedArtifactResult":{
"type":"structure",
"members":{
}
},
"DisassociateDiscoveredResourceRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName",
"ConfigurationId"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"ConfigurationId":{"shape":"ConfigurationId"},
"DryRun":{"shape":"DryRun"}
}
},
"DisassociateDiscoveredResourceResult":{
"type":"structure",
"members":{
}
},
"DiscoveredResource":{
"type":"structure",
"required":["ConfigurationId"],
"members":{
"ConfigurationId":{"shape":"ConfigurationId"},
"Description":{"shape":"DiscoveredResourceDescription"}
}
},
"DiscoveredResourceDescription":{
"type":"string",
"max":500,
"min":0
},
"DiscoveredResourceList":{
"type":"list",
"member":{"shape":"DiscoveredResource"}
},
"DryRun":{"type":"boolean"},
"DryRunOperation":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ErrorMessage":{"type":"string"},
"ImportMigrationTaskRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"DryRun":{"shape":"DryRun"}
}
},
"ImportMigrationTaskResult":{
"type":"structure",
"members":{
}
},
"InternalServerError":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true,
"fault":true
},
"InvalidInputException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"LatestResourceAttributeList":{
"type":"list",
"member":{"shape":"ResourceAttribute"},
"max":100,
"min":0
},
"ListCreatedArtifactsRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"NextToken":{"shape":"Token"},
"MaxResults":{"shape":"MaxResultsCreatedArtifacts"}
}
},
"ListCreatedArtifactsResult":{
"type":"structure",
"members":{
"NextToken":{"shape":"Token"},
"CreatedArtifactList":{"shape":"CreatedArtifactList"}
}
},
"ListDiscoveredResourcesRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"NextToken":{"shape":"Token"},
"MaxResults":{"shape":"MaxResultsResources"}
}
},
"ListDiscoveredResourcesResult":{
"type":"structure",
"members":{
"NextToken":{"shape":"Token"},
"DiscoveredResourceList":{"shape":"DiscoveredResourceList"}
}
},
"ListMigrationTasksRequest":{
"type":"structure",
"members":{
"NextToken":{"shape":"Token"},
"MaxResults":{"shape":"MaxResults"},
"ResourceName":{"shape":"ResourceName"}
}
},
"ListMigrationTasksResult":{
"type":"structure",
"members":{
"NextToken":{"shape":"Token"},
"MigrationTaskSummaryList":{"shape":"MigrationTaskSummaryList"}
}
},
"ListProgressUpdateStreamsRequest":{
"type":"structure",
"members":{
"NextToken":{"shape":"Token"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListProgressUpdateStreamsResult":{
"type":"structure",
"members":{
"ProgressUpdateStreamSummaryList":{"shape":"ProgressUpdateStreamSummaryList"},
"NextToken":{"shape":"Token"}
}
},
"MaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"MaxResultsCreatedArtifacts":{
"type":"integer",
"box":true,
"max":10,
"min":1
},
"MaxResultsResources":{
"type":"integer",
"box":true,
"max":10,
"min":1
},
"MigrationTask":{
"type":"structure",
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"Task":{"shape":"Task"},
"UpdateDateTime":{"shape":"UpdateDateTime"},
"ResourceAttributeList":{"shape":"LatestResourceAttributeList"}
}
},
"MigrationTaskName":{
"type":"string",
"max":256,
"min":1,
"pattern":"[^:|]+"
},
"MigrationTaskSummary":{
"type":"structure",
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"Status":{"shape":"Status"},
"ProgressPercent":{"shape":"ProgressPercent"},
"StatusDetail":{"shape":"StatusDetail"},
"UpdateDateTime":{"shape":"UpdateDateTime"}
}
},
"MigrationTaskSummaryList":{
"type":"list",
"member":{"shape":"MigrationTaskSummary"}
},
"NextUpdateSeconds":{
"type":"integer",
"min":0
},
"NotifyApplicationStateRequest":{
"type":"structure",
"required":[
"ApplicationId",
"Status"
],
"members":{
"ApplicationId":{"shape":"ApplicationId"},
"Status":{"shape":"ApplicationStatus"},
"DryRun":{"shape":"DryRun"}
}
},
"NotifyApplicationStateResult":{
"type":"structure",
"members":{
}
},
"NotifyMigrationTaskStateRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName",
"Task",
"UpdateDateTime",
"NextUpdateSeconds"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"Task":{"shape":"Task"},
"UpdateDateTime":{"shape":"UpdateDateTime"},
"NextUpdateSeconds":{"shape":"NextUpdateSeconds"},
"DryRun":{"shape":"DryRun"}
}
},
"NotifyMigrationTaskStateResult":{
"type":"structure",
"members":{
}
},
"PolicyErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ProgressPercent":{
"type":"integer",
"box":true,
"max":100,
"min":0
},
"ProgressUpdateStream":{
"type":"string",
"max":50,
"min":1,
"pattern":"[^/:|\\000-\\037]+"
},
"ProgressUpdateStreamSummary":{
"type":"structure",
"members":{
"ProgressUpdateStreamName":{"shape":"ProgressUpdateStream"}
}
},
"ProgressUpdateStreamSummaryList":{
"type":"list",
"member":{"shape":"ProgressUpdateStreamSummary"}
},
"PutResourceAttributesRequest":{
"type":"structure",
"required":[
"ProgressUpdateStream",
"MigrationTaskName",
"ResourceAttributeList"
],
"members":{
"ProgressUpdateStream":{"shape":"ProgressUpdateStream"},
"MigrationTaskName":{"shape":"MigrationTaskName"},
"ResourceAttributeList":{"shape":"ResourceAttributeList"},
"DryRun":{"shape":"DryRun"}
}
},
"PutResourceAttributesResult":{
"type":"structure",
"members":{
}
},
"ResourceAttribute":{
"type":"structure",
"required":[
"Type",
"Value"
],
"members":{
"Type":{"shape":"ResourceAttributeType"},
"Value":{"shape":"ResourceAttributeValue"}
}
},
"ResourceAttributeList":{
"type":"list",
"member":{"shape":"ResourceAttribute"},
"max":100,
"min":1
},
"ResourceAttributeType":{
"type":"string",
"enum":[
"IPV4_ADDRESS",
"IPV6_ADDRESS",
"MAC_ADDRESS",
"FQDN",
"VM_MANAGER_ID",
"VM_MANAGED_OBJECT_REFERENCE",
"VM_NAME",
"VM_PATH",
"BIOS_ID",
"MOTHERBOARD_SERIAL_NUMBER",
"LABEL"
]
},
"ResourceAttributeValue":{
"type":"string",
"max":256,
"min":1
},
"ResourceName":{
"type":"string",
"max":1600,
"min":1
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true,
"fault":true
},
"Status":{
"type":"string",
"enum":[
"NOT_STARTED",
"IN_PROGRESS",
"FAILED",
"COMPLETED"
]
},
"StatusDetail":{
"type":"string",
"max":500,
"min":0
},
"Task":{
"type":"structure",
"required":["Status"],
"members":{
"Status":{"shape":"Status"},
"StatusDetail":{"shape":"StatusDetail"},
"ProgressPercent":{"shape":"ProgressPercent"}
}
},
"Token":{"type":"string"},
"UnauthorizedOperation":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"UpdateDateTime":{"type":"timestamp"}
}
}

497
vendor/github.com/aws/aws-sdk-go/models/apis/mgh/2017-05-31/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,497 @@
{
"version": "2.0",
"service": "<p/>",
"operations": {
"AssociateCreatedArtifact": "<p>Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:</p> <ul> <li> <p>Migration tools can call the <code>AssociateCreatedArtifact</code> operation to indicate which AWS artifact is associated with a migration task.</p> </li> <li> <p>The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: <code>arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b</code>.</p> </li> <li> <p>Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.</p> </li> </ul>",
"AssociateDiscoveredResource": "<p>Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.</p>",
"CreateProgressUpdateStream": "<p>Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.</p>",
"DeleteProgressUpdateStream": "<p>Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:</p> <ul> <li> <p>The only parameter needed for <code>DeleteProgressUpdateStream</code> is the stream name (same as a <code>CreateProgressUpdateStream</code> call).</p> </li> <li> <p>The call will return, and a background process will asynchronously be doing the actual delete of the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).</p> </li> <li> <p>If the stream takes time to be deleted, it might still show up on a <code>ListProgressUpdateStreams</code> call.</p> </li> <li> <p> <code>CreateProgressUpdateStream</code>, <code>ImportMigrationTask</code>, <code>NotifyMigrationTaskState</code>, and all Associate[*] APIs realted to the tasks belonging to the stream will throw \"InvalidInputException\" if the stream of the same name is in the process of being deleted.</p> </li> <li> <p>Once the stream and all of its resources are deleted, <code>CreateProgressUpdateStream</code> for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).</p> </li> </ul>",
"DescribeApplicationState": "<p>Gets the migration status of an application.</p>",
"DescribeMigrationTask": "<p>Retrieves a list of all attributes associated with a specific migration task.</p>",
"DisassociateCreatedArtifact": "<p>Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:</p> <ul> <li> <p>A migration user can call the <code>DisassociateCreatedArtifacts</code> operation to disassociate a created AWS Artifact from a migration task.</p> </li> <li> <p>The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: <code>arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b</code>.</p> </li> <li> <p>Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.</p> </li> </ul>",
"DisassociateDiscoveredResource": "<p>Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.</p>",
"ImportMigrationTask": "<p>Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.</p> <p>This API is a prerequisite to calling the <code>NotifyMigrationTaskState</code> API as the migration tool must first register the migration task with Migration Hub.</p>",
"ListCreatedArtifacts": "<p>Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:</p> <ul> <li> <p>Gets the list of the created artifacts while migration is taking place.</p> </li> <li> <p>Shows the artifacts created by the migration tool that was associated by the <code>AssociateCreatedArtifact</code> API. </p> </li> <li> <p>Lists created artifacts in a paginated interface. </p> </li> </ul>",
"ListDiscoveredResources": "<p>Lists discovered resources associated with the given <code>MigrationTask</code>.</p>",
"ListMigrationTasks": "<p>Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:</p> <ul> <li> <p>Can show a summary list of the most recent migration tasks.</p> </li> <li> <p>Can show a summary list of migration tasks associated with a given discovered resource.</p> </li> <li> <p>Lists migration tasks in a paginated interface.</p> </li> </ul>",
"ListProgressUpdateStreams": "<p>Lists progress update streams associated with the user account making this call.</p>",
"NotifyApplicationState": "<p>Sets the migration state of an application. For a given application identified by the value passed to <code>ApplicationId</code>, its status is set or updated by passing one of three values to <code>Status</code>: <code>NOT_STARTED | IN_PROGRESS | COMPLETED</code>.</p>",
"NotifyMigrationTaskState": "<p>Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:</p> <ul> <li> <p>Migration tools will call the <code>NotifyMigrationTaskState</code> API to share the latest progress and status.</p> </li> <li> <p> <code>MigrationTaskName</code> is used for addressing updates to the correct target.</p> </li> <li> <p> <code>ProgressUpdateStream</code> is used for access control and to provide a namespace for each migration tool.</p> </li> </ul>",
"PutResourceAttributes": "<p>Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after <code>PutResourceAttributes</code> returns.</p> <important> <p>Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to <i>add</i> an IP address, it will then be required to call it with <i>both</i> the IP and MAC addresses to prevent overiding the MAC address.</p> </important> <note> <p>Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call <code>ListAssociatedResource</code>.</p> </note>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>Exception raised when the account making the call is not whitelisted or there are other authentication errors.</p>",
"refs": {
}
},
"ApplicationId": {
"base": null,
"refs": {
"DescribeApplicationStateRequest$ApplicationId": "<p>The configurationId in ADS that uniquely identifies the grouped application.</p>",
"NotifyApplicationStateRequest$ApplicationId": "<p>The configurationId in ADS that uniquely identifies the grouped application.</p>"
}
},
"ApplicationStatus": {
"base": null,
"refs": {
"DescribeApplicationStateResult$ApplicationStatus": "<p>Status of the application - Not Started, In-Progress, Complete.</p>",
"NotifyApplicationStateRequest$Status": "<p>Status of the application - Not Started, In-Progress, Complete.</p>"
}
},
"AssociateCreatedArtifactRequest": {
"base": null,
"refs": {
}
},
"AssociateCreatedArtifactResult": {
"base": null,
"refs": {
}
},
"AssociateDiscoveredResourceRequest": {
"base": null,
"refs": {
}
},
"AssociateDiscoveredResourceResult": {
"base": null,
"refs": {
}
},
"ConfigurationId": {
"base": null,
"refs": {
"DisassociateDiscoveredResourceRequest$ConfigurationId": "<p>ConfigurationId of the ADS resource to be disassociated.</p>",
"DiscoveredResource$ConfigurationId": "<p>The configurationId in ADS that uniquely identifies the on-premise resource.</p>"
}
},
"CreateProgressUpdateStreamRequest": {
"base": null,
"refs": {
}
},
"CreateProgressUpdateStreamResult": {
"base": null,
"refs": {
}
},
"CreatedArtifact": {
"base": "<p>An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).</p>",
"refs": {
"AssociateCreatedArtifactRequest$CreatedArtifact": "<p>An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.) </p>",
"CreatedArtifactList$member": null
}
},
"CreatedArtifactDescription": {
"base": null,
"refs": {
"CreatedArtifact$Description": "<p>A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.</p>"
}
},
"CreatedArtifactList": {
"base": null,
"refs": {
"ListCreatedArtifactsResult$CreatedArtifactList": "<p>List of created artifacts up to the maximum number of results specified in the request.</p>"
}
},
"CreatedArtifactName": {
"base": null,
"refs": {
"CreatedArtifact$Name": "<p>An ARN that uniquely identifies the result of a migration task.</p>",
"DisassociateCreatedArtifactRequest$CreatedArtifactName": "<p>An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)</p>"
}
},
"DeleteProgressUpdateStreamRequest": {
"base": null,
"refs": {
}
},
"DeleteProgressUpdateStreamResult": {
"base": null,
"refs": {
}
},
"DescribeApplicationStateRequest": {
"base": null,
"refs": {
}
},
"DescribeApplicationStateResult": {
"base": null,
"refs": {
}
},
"DescribeMigrationTaskRequest": {
"base": null,
"refs": {
}
},
"DescribeMigrationTaskResult": {
"base": null,
"refs": {
}
},
"DisassociateCreatedArtifactRequest": {
"base": null,
"refs": {
}
},
"DisassociateCreatedArtifactResult": {
"base": null,
"refs": {
}
},
"DisassociateDiscoveredResourceRequest": {
"base": null,
"refs": {
}
},
"DisassociateDiscoveredResourceResult": {
"base": null,
"refs": {
}
},
"DiscoveredResource": {
"base": "<p>Object representing the on-premises resource being migrated.</p>",
"refs": {
"AssociateDiscoveredResourceRequest$DiscoveredResource": "<p>Object representing a Resource.</p>",
"DiscoveredResourceList$member": null
}
},
"DiscoveredResourceDescription": {
"base": null,
"refs": {
"DiscoveredResource$Description": "<p>A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.</p>"
}
},
"DiscoveredResourceList": {
"base": null,
"refs": {
"ListDiscoveredResourcesResult$DiscoveredResourceList": "<p>Returned list of discovered resources associated with the given MigrationTask.</p>"
}
},
"DryRun": {
"base": null,
"refs": {
"AssociateCreatedArtifactRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"AssociateDiscoveredResourceRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"CreateProgressUpdateStreamRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"DeleteProgressUpdateStreamRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"DisassociateCreatedArtifactRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"DisassociateDiscoveredResourceRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"ImportMigrationTaskRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"NotifyApplicationStateRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"NotifyMigrationTaskStateRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>",
"PutResourceAttributesRequest$DryRun": "<p>Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.</p>"
}
},
"DryRunOperation": {
"base": "<p>Exception raised to indicate a successfully authorized action when the <code>DryRun</code> flag is set to \"true\".</p>",
"refs": {
}
},
"ErrorMessage": {
"base": null,
"refs": {
"AccessDeniedException$Message": null,
"DryRunOperation$Message": null,
"InternalServerError$Message": null,
"InvalidInputException$Message": null,
"PolicyErrorException$Message": null,
"ResourceNotFoundException$Message": null,
"ServiceUnavailableException$Message": null,
"UnauthorizedOperation$Message": null
}
},
"ImportMigrationTaskRequest": {
"base": null,
"refs": {
}
},
"ImportMigrationTaskResult": {
"base": null,
"refs": {
}
},
"InternalServerError": {
"base": "<p>Exception raised when there is an internal, configuration, or dependency error encountered.</p>",
"refs": {
}
},
"InvalidInputException": {
"base": "<p>Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.</p>",
"refs": {
}
},
"LatestResourceAttributeList": {
"base": null,
"refs": {
"MigrationTask$ResourceAttributeList": "<p/>"
}
},
"ListCreatedArtifactsRequest": {
"base": null,
"refs": {
}
},
"ListCreatedArtifactsResult": {
"base": null,
"refs": {
}
},
"ListDiscoveredResourcesRequest": {
"base": null,
"refs": {
}
},
"ListDiscoveredResourcesResult": {
"base": null,
"refs": {
}
},
"ListMigrationTasksRequest": {
"base": null,
"refs": {
}
},
"ListMigrationTasksResult": {
"base": null,
"refs": {
}
},
"ListProgressUpdateStreamsRequest": {
"base": null,
"refs": {
}
},
"ListProgressUpdateStreamsResult": {
"base": null,
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"ListMigrationTasksRequest$MaxResults": "<p>Value to specify how many results are returned per page.</p>",
"ListProgressUpdateStreamsRequest$MaxResults": "<p>Filter to limit the maximum number of results to list per page.</p>"
}
},
"MaxResultsCreatedArtifacts": {
"base": null,
"refs": {
"ListCreatedArtifactsRequest$MaxResults": "<p>Maximum number of results to be returned per page.</p>"
}
},
"MaxResultsResources": {
"base": null,
"refs": {
"ListDiscoveredResourcesRequest$MaxResults": "<p>The maximum number of results returned per page.</p>"
}
},
"MigrationTask": {
"base": "<p>Represents a migration task in a migration tool.</p>",
"refs": {
"DescribeMigrationTaskResult$MigrationTask": "<p>Object encapsulating information about the migration task.</p>"
}
},
"MigrationTaskName": {
"base": null,
"refs": {
"AssociateCreatedArtifactRequest$MigrationTaskName": "<p>Unique identifier that references the migration task.</p>",
"AssociateDiscoveredResourceRequest$MigrationTaskName": "<p>The identifier given to the MigrationTask.</p>",
"DescribeMigrationTaskRequest$MigrationTaskName": "<p>The identifier given to the MigrationTask.</p>",
"DisassociateCreatedArtifactRequest$MigrationTaskName": "<p>Unique identifier that references the migration task to be disassociated with the artifact.</p>",
"DisassociateDiscoveredResourceRequest$MigrationTaskName": "<p>The identifier given to the MigrationTask.</p>",
"ImportMigrationTaskRequest$MigrationTaskName": "<p>Unique identifier that references the migration task.</p>",
"ListCreatedArtifactsRequest$MigrationTaskName": "<p>Unique identifier that references the migration task.</p>",
"ListDiscoveredResourcesRequest$MigrationTaskName": "<p>The name of the MigrationTask.</p>",
"MigrationTask$MigrationTaskName": "<p>Unique identifier that references the migration task.</p>",
"MigrationTaskSummary$MigrationTaskName": "<p>Unique identifier that references the migration task.</p>",
"NotifyMigrationTaskStateRequest$MigrationTaskName": "<p>Unique identifier that references the migration task.</p>",
"PutResourceAttributesRequest$MigrationTaskName": "<p>Unique identifier that references the migration task.</p>"
}
},
"MigrationTaskSummary": {
"base": "<p>MigrationTaskSummary includes <code>MigrationTaskName</code>, <code>ProgressPercent</code>, <code>ProgressUpdateStream</code>, <code>Status</code>, and <code>UpdateDateTime</code> for each task.</p>",
"refs": {
"MigrationTaskSummaryList$member": null
}
},
"MigrationTaskSummaryList": {
"base": null,
"refs": {
"ListMigrationTasksResult$MigrationTaskSummaryList": "<p>Lists the migration task's summary which includes: <code>MigrationTaskName</code>, <code>ProgressPercent</code>, <code>ProgressUpdateStream</code>, <code>Status</code>, and the <code>UpdateDateTime</code> for each task.</p>"
}
},
"NextUpdateSeconds": {
"base": null,
"refs": {
"NotifyMigrationTaskStateRequest$NextUpdateSeconds": "<p>Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.</p>"
}
},
"NotifyApplicationStateRequest": {
"base": null,
"refs": {
}
},
"NotifyApplicationStateResult": {
"base": null,
"refs": {
}
},
"NotifyMigrationTaskStateRequest": {
"base": null,
"refs": {
}
},
"NotifyMigrationTaskStateResult": {
"base": null,
"refs": {
}
},
"PolicyErrorException": {
"base": "<p>Exception raised when there are problems accessing ADS (Application Discovery Service); most likely due to a misconfigured policy or the <code>ADSCaller</code> role is missing or not configured correctly.</p>",
"refs": {
}
},
"ProgressPercent": {
"base": null,
"refs": {
"MigrationTaskSummary$ProgressPercent": "<p/>",
"Task$ProgressPercent": "<p>Indication of the percentage completion of the task.</p>"
}
},
"ProgressUpdateStream": {
"base": null,
"refs": {
"AssociateCreatedArtifactRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream. </p>",
"AssociateDiscoveredResourceRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream.</p>",
"CreateProgressUpdateStreamRequest$ProgressUpdateStreamName": "<p>The name of the ProgressUpdateStream. </p>",
"DeleteProgressUpdateStreamRequest$ProgressUpdateStreamName": "<p>The name of the ProgressUpdateStream. </p>",
"DescribeMigrationTaskRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream. </p>",
"DisassociateCreatedArtifactRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream. </p>",
"DisassociateDiscoveredResourceRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream.</p>",
"ImportMigrationTaskRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream. </p>",
"ListCreatedArtifactsRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream. </p>",
"ListDiscoveredResourcesRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream.</p>",
"MigrationTask$ProgressUpdateStream": "<p>A name that identifies the vendor of the migration tool being used.</p>",
"MigrationTaskSummary$ProgressUpdateStream": "<p>An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.</p>",
"NotifyMigrationTaskStateRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream. </p>",
"ProgressUpdateStreamSummary$ProgressUpdateStreamName": "<p>The name of the ProgressUpdateStream. </p>",
"PutResourceAttributesRequest$ProgressUpdateStream": "<p>The name of the ProgressUpdateStream. </p>"
}
},
"ProgressUpdateStreamSummary": {
"base": "<p>Summary of the AWS resource used for access control that is implicitly linked to your AWS account.</p>",
"refs": {
"ProgressUpdateStreamSummaryList$member": null
}
},
"ProgressUpdateStreamSummaryList": {
"base": null,
"refs": {
"ListProgressUpdateStreamsResult$ProgressUpdateStreamSummaryList": "<p>List of progress update streams up to the max number of results passed in the input.</p>"
}
},
"PutResourceAttributesRequest": {
"base": null,
"refs": {
}
},
"PutResourceAttributesResult": {
"base": null,
"refs": {
}
},
"ResourceAttribute": {
"base": "<p>Attribute associated with a resource.</p>",
"refs": {
"LatestResourceAttributeList$member": null,
"ResourceAttributeList$member": null
}
},
"ResourceAttributeList": {
"base": null,
"refs": {
"PutResourceAttributesRequest$ResourceAttributeList": "<p>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.</p>"
}
},
"ResourceAttributeType": {
"base": null,
"refs": {
"ResourceAttribute$Type": "<p>Type of resource.</p>"
}
},
"ResourceAttributeValue": {
"base": null,
"refs": {
"ResourceAttribute$Value": "<p>Value of the resource type.</p>"
}
},
"ResourceName": {
"base": null,
"refs": {
"ListMigrationTasksRequest$ResourceName": "<p>Filter migration tasks by discovered resource name.</p>"
}
},
"ResourceNotFoundException": {
"base": "<p>Exception raised when the request references a resource (ADS configuration, update stream, migration task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.</p>",
"refs": {
}
},
"ServiceUnavailableException": {
"base": "<p>Exception raised when the service encounters throttled communication with upstream dependencies or is overloaded with requests.</p>",
"refs": {
}
},
"Status": {
"base": null,
"refs": {
"MigrationTaskSummary$Status": "<p>Status of the task.</p>",
"Task$Status": "<p>Status of the task - Not Started, In-Progress, Complete.</p>"
}
},
"StatusDetail": {
"base": null,
"refs": {
"MigrationTaskSummary$StatusDetail": "<p>Detail information of what is being done within the overall status state.</p>",
"Task$StatusDetail": "<p>Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.</p>"
}
},
"Task": {
"base": "<p>Task object encapsulating task information.</p>",
"refs": {
"MigrationTask$Task": "<p>Task object encapsulating task information.</p>",
"NotifyMigrationTaskStateRequest$Task": "<p>Information about the task's progress and status.</p>"
}
},
"Token": {
"base": null,
"refs": {
"ListCreatedArtifactsRequest$NextToken": "<p>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>",
"ListCreatedArtifactsResult$NextToken": "<p>If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.</p>",
"ListDiscoveredResourcesRequest$NextToken": "<p>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>",
"ListDiscoveredResourcesResult$NextToken": "<p>If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from.</p>",
"ListMigrationTasksRequest$NextToken": "<p>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>",
"ListMigrationTasksResult$NextToken": "<p>If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from.</p>",
"ListProgressUpdateStreamsRequest$NextToken": "<p>If a <code>NextToken</code> was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in <code>NextToken</code>.</p>",
"ListProgressUpdateStreamsResult$NextToken": "<p>If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from.</p>"
}
},
"UnauthorizedOperation": {
"base": "<p>Exception raised to indicate a request was not authorized when the <code>DryRun</code> flag is set to \"true\".</p>",
"refs": {
}
},
"UpdateDateTime": {
"base": null,
"refs": {
"DescribeApplicationStateResult$LastUpdatedTime": "<p>The timestamp when the application status was last updated.</p>",
"MigrationTask$UpdateDateTime": "<p>The timestamp when the task was gathered.</p>",
"MigrationTaskSummary$UpdateDateTime": "<p>The timestamp when the task was gathered.</p>",
"NotifyMigrationTaskStateRequest$UpdateDateTime": "<p>The timestamp when the task was gathered.</p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/mgh/2017-05-31/examples-1.json generated vendored Normal file
View File

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

4
vendor/github.com/aws/aws-sdk-go/models/apis/mgh/2017-05-31/paginators-1.json generated vendored Normal file
View File

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

18
vendor/github.com/aws/aws-sdk-go/models/apis/monitoring/2010-08-01/docs-2.json generated vendored
View File

@@ -10,10 +10,10 @@
"DisableAlarmActions": "<p>Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.</p>",
"EnableAlarmActions": "<p>Enables the actions for the specified alarms.</p>",
"GetDashboard": "<p>Displays the details of the dashboard that you specify.</p> <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code> to create the copy.</p>",
"GetMetricStatistics": "<p>Gets statistics for the specified metric.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)</p> </li> </ul> <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. A period can be as short as one minute (60 seconds). Data points are not returned in chronological order.</p> <p>CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The SampleCount value of the statistic set is 1.</p> </li> <li> <p>The Min and the Max values of the statistic set are equal.</p> </li> </ul> <p>For a list of metrics and dimensions supported by AWS services, see the <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.</p>",
"GetMetricStatistics": "<p>Gets statistics for the specified metric.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.</p> <p>CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The SampleCount value of the statistic set is 1.</p> </li> <li> <p>The Min and the Max values of the statistic set are equal.</p> </li> </ul> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p> </li> <li> <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p> </li> <li> <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p> </li> </ul> <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.</p> <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p> <p>For information about metrics and dimensions supported by AWS services, see the <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.</p>",
"ListDashboards": "<p>Returns a list of the dashboards for your account. If you include <code>DashboardNamePrefix</code>, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. </p>",
"ListMetrics": "<p>List the specified metrics. You can use the returned metrics with <a>GetMetricStatistics</a> to obtain statistical data.</p> <p>Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.</p> <p>After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>.</p>",
"PutDashboard": "<p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.</p> <p>You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.</p> <p>To copy an existing dashboard, use <code>GetDashboard</code>, and then use the data returned within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code> to create the copy.</p>",
"PutDashboard": "<p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.</p> <p>You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.</p> <p>A simple way to create a dashboard using <code>PutDashboard</code> is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use <code>GetDashboard</code>, and then use the data returned within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code>.</p> <p>When you create a dashboard with <code>PutDashboard</code>, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the <code>DashboardBody</code> script or the CloudFormation template used to create the dashboard.</p>",
"PutMetricAlarm": "<p>Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.</p> <p>When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.</p> <p>If you are an IAM user, you must have Amazon EC2 permissions for some operations:</p> <ul> <li> <p> <code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on EC2 instance status metrics</p> </li> <li> <p> <code>ec2:StopInstances</code> for alarms with stop actions</p> </li> <li> <p> <code>ec2:TerminateInstances</code> for alarms with terminate actions</p> </li> <li> <p> <code>ec2:DescribeInstanceRecoveryAttribute</code> and <code>ec2:RecoverInstances</code> for alarms with recover actions</p> </li> </ul> <p>If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.</p> <p>If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.</p> <p>If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.</p> <p>You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the <b>EC2ActionsAccess</b> IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.</p>",
"PutMetricData": "<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a>ListMetrics</a>.</p> <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p> <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a>GetMetricStatistics</a> from the time they are submitted.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The SampleCount value of the statistic set is 1</p> </li> <li> <p>The Min and the Max values of the statistic set are equal</p> </li> </ul>",
"SetAlarmState": "<p>Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to <code>ALARM</code> sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <a>DescribeAlarmHistory</a>.</p>"
@@ -143,7 +143,7 @@
"DashboardNames$member": null,
"GetDashboardInput$DashboardName": "<p>The name of the dashboard to be described.</p>",
"GetDashboardOutput$DashboardName": "<p>The name of the dashboard.</p>",
"PutDashboardInput$DashboardName": "<p>The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".</p>"
"PutDashboardInput$DashboardName": "<p>The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, \"-\", and \"_\".</p>"
}
},
"DashboardNamePrefix": {
@@ -326,7 +326,7 @@
"EvaluateLowSampleCountPercentile": {
"base": null,
"refs": {
"MetricAlarm$EvaluateLowSampleCountPercentile": "<p>Used only for alarms based on percentiles. If <code>ignore</code>, the alarm state does not change during periods with too few data points to be statistically significant. If <code>evaluate</code> or this parameter is not used, the alarm will always be evaluated and possibly change state no matter how many data points are available.</p>",
"MetricAlarm$EvaluateLowSampleCountPercentile": "<p>Used only for alarms based on percentiles. If <code>ignore</code>, the alarm state does not change during periods with too few data points to be statistically significant. If <code>evaluate</code> or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.</p>",
"PutMetricAlarmInput$EvaluateLowSampleCountPercentile": "<p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the alarm state does not change during periods with too few data points to be statistically significant. If you specify <code>evaluate</code> or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples\">Percentile-Based CloudWatch Alarms and Low Data Samples</a>.</p> <p>Valid Values: <code>evaluate | ignore</code> </p>"
}
},
@@ -334,7 +334,7 @@
"base": null,
"refs": {
"MetricAlarm$EvaluationPeriods": "<p>The number of periods over which data is compared to the specified threshold.</p>",
"PutMetricAlarmInput$EvaluationPeriods": "<p>The number of periods over which data is compared to the specified threshold. An alarm's total current evaluation period can be no longer than one day, so this number multiplied by <code>Period</code> must be 86,400 or less.</p>"
"PutMetricAlarmInput$EvaluationPeriods": "<p>The number of periods over which data is compared to the specified threshold. An alarm's total current evaluation period can be no longer than one day, so this number multiplied by <code>Period</code> cannot be more than 86,400 seconds.</p>"
}
},
"ExtendedStatistic": {
@@ -556,9 +556,9 @@
"base": null,
"refs": {
"DescribeAlarmsForMetricInput$Period": "<p>The period, in seconds, over which the statistic is applied.</p>",
"GetMetricStatisticsInput$Period": "<p>The granularity, in seconds, of the returned data points. A period can be as short as one minute (60 seconds) and must be a multiple of 60. </p> <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than 15 days ago, you must specify the period as follows or no data points in that time range is returned:</p> <ul> <li> <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p> </li> <li> <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p> </li> </ul>",
"GetMetricStatisticsInput$Period": "<p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p> <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:</p> <ul> <li> <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).</p> </li> <li> <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p> </li> <li> <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p> </li> </ul>",
"MetricAlarm$Period": "<p>The period, in seconds, over which the statistic is applied.</p>",
"PutMetricAlarmInput$Period": "<p>The period, in seconds, over which the specified statistic is applied. An alarm's total current evaluation period can be no longer than one day, so this number multiplied by <code>EvaluationPeriods</code> must be 86,400 or less.</p>"
"PutMetricAlarmInput$Period": "<p>The period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60.</p> <p>Be sure to specify 10 or 30 only for metrics that are stored by a <code>PutMetricData</code> call with a <code>StorageResolution</code> of 1. If you specify a Period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>An alarm's total current evaluation period can be no longer than one day, so <code>Period</code> multiplied by <code>EvaluationPeriods</code> cannot be more than 86,400 seconds.</p>"
}
},
"PutDashboardInput": {
@@ -671,7 +671,7 @@
"StorageResolution": {
"base": null,
"refs": {
"MetricDatum$StorageResolution": null
"MetricDatum$StorageResolution": "<p>Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics\">High-Resolution Metrics</a> in the <i>Amazon CloudWatch User Guide</i>. </p> <p>This field is optional, if you do not specify it the default of 60 is used.</p>"
}
},
"Threshold": {
@@ -688,7 +688,7 @@
"Datapoint$Timestamp": "<p>The time stamp used for the data point.</p>",
"DescribeAlarmHistoryInput$StartDate": "<p>The starting date to retrieve alarm history.</p>",
"DescribeAlarmHistoryInput$EndDate": "<p>The ending date to retrieve alarm history.</p>",
"GetMetricStatisticsInput$StartTime": "<p>The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.</p> <p>The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).</p> <p>CloudWatch rounds the specified time stamp as follows:</p> <ul> <li> <p>Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.</p> </li> <li> <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.</p> </li> <li> <p>Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p> </li> </ul>",
"GetMetricStatisticsInput$StartTime": "<p>The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.</p> <p>The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).</p> <p>CloudWatch rounds the specified time stamp as follows:</p> <ul> <li> <p>Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.</p> </li> <li> <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.</p> </li> <li> <p>Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.</p> </li> </ul> <p>If you set <code>Period</code> to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15. </p>",
"GetMetricStatisticsInput$EndTime": "<p>The time stamp that determines the last data point to return.</p> <p>The value specified is exclusive; results include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).</p>",
"MetricAlarm$AlarmConfigurationUpdatedTimestamp": "<p>The time stamp of the last update to the alarm configuration.</p>",
"MetricAlarm$StateUpdatedTimestamp": "<p>The time stamp of the last update to the alarm state.</p>",

52
vendor/github.com/aws/aws-sdk-go/models/apis/mturk-requester/2017-01-17/api-2.json generated vendored
View File

@@ -629,7 +629,7 @@
"type":"structure",
"members":{
"WorkerId":{"shape":"CustomerId"},
"BonusAmount":{"shape":"NumericValue"},
"BonusAmount":{"shape":"CurrencyAmount"},
"AssignmentId":{"shape":"EntityId"},
"Reason":{"shape":"String"},
"GrantTime":{"shape":"Timestamp"}
@@ -662,7 +662,10 @@
},
"CreateAdditionalAssignmentsForHITRequest":{
"type":"structure",
"required":["HITId"],
"required":[
"HITId",
"NumberOfAdditionalAssignments"
],
"members":{
"HITId":{"shape":"EntityId"},
"NumberOfAdditionalAssignments":{"shape":"Integer"},
@@ -688,7 +691,7 @@
"AutoApprovalDelayInSeconds":{"shape":"Long"},
"LifetimeInSeconds":{"shape":"Long"},
"AssignmentDurationInSeconds":{"shape":"Long"},
"Reward":{"shape":"NumericValue"},
"Reward":{"shape":"CurrencyAmount"},
"Title":{"shape":"String"},
"Keywords":{"shape":"String"},
"Description":{"shape":"String"},
@@ -719,7 +722,7 @@
"members":{
"AutoApprovalDelayInSeconds":{"shape":"Long"},
"AssignmentDurationInSeconds":{"shape":"Long"},
"Reward":{"shape":"NumericValue"},
"Reward":{"shape":"CurrencyAmount"},
"Title":{"shape":"String"},
"Keywords":{"shape":"String"},
"Description":{"shape":"String"},
@@ -799,6 +802,10 @@
"members":{
}
},
"CurrencyAmount":{
"type":"string",
"pattern":"^[0-9]+(\\.)?[0-9]{0,2}$"
},
"CustomerId":{
"type":"string",
"max":64,
@@ -899,8 +906,8 @@
"GetAccountBalanceResponse":{
"type":"structure",
"members":{
"AvailableBalance":{"shape":"NumericValue"},
"OnHoldBalance":{"shape":"NumericValue"}
"AvailableBalance":{"shape":"CurrencyAmount"},
"OnHoldBalance":{"shape":"CurrencyAmount"}
}
},
"GetAssignmentRequest":{
@@ -991,7 +998,7 @@
"Keywords":{"shape":"String"},
"HITStatus":{"shape":"HITStatus"},
"MaxAssignments":{"shape":"Integer"},
"Reward":{"shape":"NumericValue"},
"Reward":{"shape":"CurrencyAmount"},
"AutoApprovalDelayInSeconds":{"shape":"Long"},
"Expiration":{"shape":"Timestamp"},
"AssignmentDurationInSeconds":{"shape":"Long"},
@@ -1005,6 +1012,10 @@
},
"HITLayoutParameter":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{"shape":"String"},
"Value":{"shape":"String"}
@@ -1239,7 +1250,9 @@
"type":"structure",
"required":[
"Destination",
"Transport"
"Transport",
"Version",
"EventTypes"
],
"members":{
"Destination":{"shape":"String"},
@@ -1252,7 +1265,8 @@
"type":"string",
"enum":[
"Email",
"SQS"
"SQS",
"SNS"
]
},
"NotifyWorkersFailureCode":{
@@ -1293,10 +1307,6 @@
"NotifyWorkersFailureStatuses":{"shape":"NotifyWorkersFailureStatusList"}
}
},
"NumericValue":{
"type":"string",
"pattern":"^[0-9]+(\\.)?[0-9]*$"
},
"PaginationToken":{
"type":"string",
"max":255,
@@ -1411,7 +1421,10 @@
},
"RejectAssignmentRequest":{
"type":"structure",
"required":["AssignmentId"],
"required":[
"AssignmentId",
"RequesterFeedback"
],
"members":{
"AssignmentId":{"shape":"EntityId"},
"RequesterFeedback":{"shape":"String"}
@@ -1476,6 +1489,7 @@
},
"ReviewPolicy":{
"type":"structure",
"required":["PolicyName"],
"members":{
"PolicyName":{"shape":"String"},
"Parameters":{"shape":"PolicyParameterList"}
@@ -1526,11 +1540,12 @@
"required":[
"WorkerId",
"BonusAmount",
"AssignmentId"
"AssignmentId",
"Reason"
],
"members":{
"WorkerId":{"shape":"CustomerId"},
"BonusAmount":{"shape":"NumericValue"},
"BonusAmount":{"shape":"CurrencyAmount"},
"AssignmentId":{"shape":"EntityId"},
"Reason":{"shape":"String"},
"UniqueRequestToken":{"shape":"IdempotencyToken"}
@@ -1575,7 +1590,10 @@
"TurkErrorCode":{"type":"string"},
"UpdateExpirationForHITRequest":{
"type":"structure",
"required":["HITId"],
"required":[
"HITId",
"ExpireAt"
],
"members":{
"HITId":{"shape":"EntityId"},
"ExpireAt":{"shape":"Timestamp"}

28
vendor/github.com/aws/aws-sdk-go/models/apis/mturk-requester/2017-01-17/docs-2.json generated vendored
View File

@@ -202,6 +202,18 @@
"refs": {
}
},
"CurrencyAmount": {
"base": "<p>A string representing a currency amount.</p>",
"refs": {
"BonusPayment$BonusAmount": null,
"CreateHITRequest$Reward": "<p> The amount of money the Requester will pay a Worker for successfully completing the HIT. </p>",
"CreateHITTypeRequest$Reward": "<p> The amount of money the Requester will pay a Worker for successfully completing the HIT. </p>",
"GetAccountBalanceResponse$AvailableBalance": null,
"GetAccountBalanceResponse$OnHoldBalance": null,
"HIT$Reward": null,
"SendBonusRequest$BonusAmount": "<p> The Bonus amount is a US Dollar amount specified using a string (for example, \"5\" represents $5.00 USD and \"101.42\" represents $101.42 USD). Do not include currency symbols or currency codes. </p>"
}
},
"CustomerId": {
"base": null,
"refs": {
@@ -626,7 +638,7 @@
"NotificationTransport": {
"base": null,
"refs": {
"NotificationSpecification$Transport": "<p> The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS. </p>"
"NotificationSpecification$Transport": "<p> The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS. </p>"
}
},
"NotifyWorkersFailureCode": {
@@ -657,18 +669,6 @@
"refs": {
}
},
"NumericValue": {
"base": "<p>A string representing a numeric value.</p>",
"refs": {
"BonusPayment$BonusAmount": null,
"CreateHITRequest$Reward": "<p> The amount of money the Requester will pay a Worker for successfully completing the HIT. </p>",
"CreateHITTypeRequest$Reward": "<p> The amount of money the Requester will pay a Worker for successfully completing the HIT. </p>",
"GetAccountBalanceResponse$AvailableBalance": null,
"GetAccountBalanceResponse$OnHoldBalance": null,
"HIT$Reward": null,
"SendBonusRequest$BonusAmount": "<p> The Bonus amount is a US Dollar amount specified using a string (for example, \"5\" represents $5.00 USD and \"101.42\" represents $101.42 USD). Do not include currency symbols or currency codes. </p>"
}
},
"PaginationToken": {
"base": "<p>If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. </p>",
"refs": {
@@ -954,7 +954,7 @@
"HITLayoutParameter$Name": "<p> The name of the parameter in the HITLayout. </p>",
"HITLayoutParameter$Value": "<p>The value substituted for the parameter referenced in the HITLayout. </p>",
"ListQualificationTypesRequest$Query": "<p> A text query against all of the searchable attributes of Qualification types. </p>",
"NotificationSpecification$Destination": "<p> The destination for notification messages. or email notifications (if Transport is Email), this is an email address. For Amazon Simple Queue Service (Amazon SQS) notifications (if Transport is SQS), this is the URL for your Amazon SQS queue. </p>",
"NotificationSpecification$Destination": "<p> The target for notification messages. The Destination’s format is determined by the specified Transport: </p> <ul> <li> <p>When Transport is Email, the Destination is your email address.</p> </li> <li> <p>When Transport is SQS, the Destination is your queue URL.</p> </li> <li> <p>When Transport is SNS, the Destination is the ARN of your topic.</p> </li> </ul>",
"NotificationSpecification$Version": "<p>The version of the Notification API to use. Valid value is 2006-05-05.</p>",
"NotifyWorkersFailureStatus$NotifyWorkersFailureMessage": "<p> A message detailing the reason the Worker could not be notified. </p>",
"NotifyWorkersRequest$Subject": "<p>The subject line of the email message to send. Can include up to 200 characters.</p>",

7
vendor/github.com/aws/aws-sdk-go/models/apis/organizations/2016-11-28/api-2.json generated vendored
View File

@@ -898,7 +898,8 @@
"MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED",
"MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED",
"ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED",
"MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE"
"MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE",
"MASTER_ACCOUNT_MISSING_CONTACT_INFO"
]
},
"CreateAccountFailureReason":{
@@ -1309,6 +1310,10 @@
},
"HandshakeParty":{
"type":"structure",
"required":[
"Id",
"Type"
],
"members":{
"Id":{"shape":"HandshakePartyId"},
"Type":{"shape":"HandshakePartyType"}

22
vendor/github.com/aws/aws-sdk-go/models/apis/organizations/2016-11-28/docs-2.json generated vendored
View File

@@ -5,12 +5,12 @@
"AcceptHandshake": "<p>Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request. </p> <p>This operation can be called only by the following principals when they also have the relevant IAM permissions:</p> <ul> <li> <p> <b>Invitation to join</b> or <b>Approve all features request</b> handshakes: only a principal from the member account. </p> </li> <li> <p> <b>Enable all features final confirmation</b> handshake: only a principal from the master account.</p> <p>For more information about invitations, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_invites.html\">Inviting an AWS Account to Join Your Organization</a> in the <i>AWS Organizations User Guide</i>. For more information about requests to enable all features in the organization, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide</i>.</p> </li> </ul> <p>After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.</p>",
"AttachPolicy": "<p>Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy:</p> <ul> <li> <p> <b>Service control policy (SCP)</b> - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:</p> <ul> <li> <p>If you attach an SCP to a root, it affects all accounts in the organization.</p> </li> <li> <p>If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.</p> </li> <li> <p>If you attach the policy directly to an account, then it affects only that account.</p> </li> </ul> <p>SCPs essentially are permission \"filters\". When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.</p> <p>AWS Organizations attaches a default SCP named <code>\"FullAWSAccess</code> to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.</p> <p>For more information about how Organizations policies permissions work, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scp.html\">Using Service Control Policies</a> in the <i>AWS Organizations User Guide</i>.</p> </li> </ul> <p>This operation can be called only from the organization's master account.</p>",
"CancelHandshake": "<p>Cancels a handshake. Canceling a handshake sets the handshake state to <code>CANCELED</code>. </p> <p>This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use <a>DeclineHandshake</a> instead. After a handshake is canceled, the recipient can no longer respond to that handshake.</p> <p>After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.</p>",
"CreateAccount": "<p>Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. If you want to check the status of the request later, you need the <code>OperationId</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> <p>AWS Organizations preconfigures the new member account with a role (named <code>OrganizationAccountAccessRole</code> by default) that grants administrator permissions to the new account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.</p> <p>For more information about creating accounts, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an AWS Account in Your Organization</a> in the <i>AWS Organizations User Guide</i>.</p> <important> <p>You cannot remove accounts that are created with this operation from an organization. That also means that you cannot delete an organization that contains an account that is created with this operation.</p> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable this, then only the account root user can access billing information. For information about how to disable this for an account, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note> <p>This operation can be called only from the organization's master account.</p>",
"CreateAccount": "<p>Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. If you want to check the status of the request later, you need the <code>OperationId</code> response element from this operation to provide as a parameter to the <a>DescribeCreateAccountStatus</a> operation.</p> <p>AWS Organizations preconfigures the new member account with a role (named <code>OrganizationAccountAccessRole</code> by default) that grants administrator permissions to the new account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.</p> <p>For more information about creating accounts, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html\">Creating an AWS Account in Your Organization</a> in the <i>AWS Organizations User Guide</i>.</p> <important> <p>When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the End User Licence Agreement (EULA) is <i>not</i> automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>.</p> </important> <note> <p>When you create a member account with this operation, you can choose whether to create the account with the <b>IAM User and Role Access to Billing Information</b> switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable this, then only the account root user can access billing information. For information about how to disable this for an account, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html\">Granting Access to Your Billing Information and Tools</a>.</p> </note> <p>This operation can be called only from the organization's master account.</p> <important> <p>If you get an exception that indicates that you exceeded your account limits for the organization or that you can\"t add an account because your organization is still initializing, please contact <a href=\"https://console.aws.amazon.com/support/home#/\"> AWS Customer Support</a>.</p> </important>",
"CreateOrganization": "<p>Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/orgs_getting-started_concepts.html#account\">master account</a> of the new organization.</p> <p>This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.</p> <p>By default (or if you set the <code>FeatureSet</code> parameter to <code>ALL</code>), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the <code>FeatureSet</code> parameter to <code>CONSOLIDATED_BILLING\"</code>, then no policy types are enabled by default and you cannot use organization policies.</p>",
"CreateOrganizationalUnit": "<p>Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five. </p> <p>For more information about OUs, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_ous.html\">Managing Organizational Units</a> in the <i>AWS Organizations User Guide</i>.</p> <p>This operation can be called only from the organization's master account.</p>",
"CreatePolicy": "<p>Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.</p> <p>For more information about policies and their use, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html\">Managing Organization Policies</a>.</p> <p>This operation can be called only from the organization's master account.</p>",
"DeclineHandshake": "<p>Declines a handshake request. This sets the handshake state to <code>DECLINED</code> and effectively deactivates the request.</p> <p>This operation can be called only from the account that received the handshake. The originator of the handshake can use <a>CancelHandshake</a> instead. The originator can't reactivate a declined request, but can re-initiate the process with a new handshake request.</p> <p>After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.</p>",
"DeleteOrganization": "<p>Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts, OUs, and policies.</p> <important> <p>If you create any accounts using Organizations operations or the Organizations console, you can't remove those accounts from the organization, which means that you can't delete the organization.</p> </important>",
"DeleteOrganization": "<p>Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts, OUs, and policies.</p>",
"DeleteOrganizationalUnit": "<p>Deletes an organizational unit from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.</p> <p>This operation can be called only from the organization's master account.</p>",
"DeletePolicy": "<p>Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all OUs, roots, and accounts.</p> <p>This operation can be called only from the organization's master account.</p>",
"DescribeAccount": "<p>Retrieves Organizations-related information about the specified account.</p> <p>This operation can be called only from the organization's master account.</p>",
@@ -20,11 +20,11 @@
"DescribeOrganizationalUnit": "<p>Retrieves information about an organizational unit (OU).</p> <p>This operation can be called only from the organization's master account.</p>",
"DescribePolicy": "<p>Retrieves information about a policy.</p> <p>This operation can be called only from the organization's master account.</p>",
"DetachPolicy": "<p>Detaches a policy from a target root, organizational unit, or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.</p> <p> <b>Note:</b> Every root, OU, and account must have at least one SCP attached. If you want to replace the default <code>FullAWSAccess</code> policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_whitelist\">whitelisting</a>. If you instead attach a second SCP and leave the <code>FullAWSAccess</code> SCP still attached, and specify <code>\"Effect\": \"Deny\"</code> in the second SCP to override the <code>\"Effect\": \"Allow\"</code> in the <code>FullAWSAccess</code> policy (or any other attached SCP), then you are using the authorization strategy of <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html#orgs_policies_blacklist\">blacklisting</a>. </p> <p>This operation can be called only from the organization's master account.</p>",
"DisablePolicyType": "<p>Disables an organizational control policy type in a root. A poicy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any OU or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This operation can be called only from the organization's master account.</p>",
"DisablePolicyType": "<p>Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any OU or account in that root. You can undo this by using the <a>EnablePolicyType</a> operation.</p> <p>This operation can be called only from the organization's master account.</p>",
"EnableAllFeatures": "<p>Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html\">Enabling All Features in Your Organization</a> in the <i>AWS Organizations User Guide</i>.</p> <important> <p>This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled, or that were migrated from a Consolidated Billing account family to Organizations. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.</p> </important> <p>After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains <code>\"Action\": \"ENABLE_ALL_FEATURES\"</code>. This completes the change.</p> <p>After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.</p> <p>This operation can be called only from the organization's master account. </p>",
"EnablePolicyType": "<p>Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any OU, or account in that root. You can undo this by using the <a>DisablePolicyType</a> operation.</p> <p>This operation can be called only from the organization's master account.</p>",
"InviteAccountToOrganization": "<p>Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a <a>Handshake</a> whose details are in the response.</p> <important> <p>You can invite AWS accounts only from the same reseller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS reseller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilliing-India.html\">Consolidated Billing in India</a>.</p> </important> <p>This operation can be called only from the organization's master account.</p>",
"LeaveOrganization": "<p>Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use <a>RemoveAccountFromOrganization</a> instead.</p> <p>This operation can be called only from a member account in the organization.</p> <important> <ul> <li> <p>The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling <code>LeaveOrganization</code> and leaving the organization. </p> </li> <li> <p>If you created the account using the AWS Organizations console, the Organizations API, or the Organizations CLI commands, then you cannot remove the account.</p> </li> <li> <p>You can leave an organization only after you enable IAM user access to billing in your account. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </li> </ul> </important>",
"InviteAccountToOrganization": "<p>Sends an invitation to another account to join your organization as a member account. Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a <a>Handshake</a> whose details are in the response.</p> <important> <p>You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/useconsolidatedbilliing-India.html\">Consolidated Billing in India</a>.</p> </important> <p>This operation can be called only from the organization's master account.</p> <important> <p>If you get an exception that indicates that you exceeded your account limits for the organization or that you can\"t add an account because your organization is still initializing, please contact <a href=\"https://console.aws.amazon.com/support/home#/\"> AWS Customer Support</a>.</p> </important>",
"LeaveOrganization": "<p>Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use <a>RemoveAccountFromOrganization</a> instead.</p> <p>This operation can be called only from a member account in the organization.</p> <important> <ul> <li> <p>The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling <code>LeaveOrganization</code> and leaving the organization. </p> </li> <li> <p>You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>You can leave an organization only after you enable IAM user access to billing in your account. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </li> </ul> </important>",
"ListAccounts": "<p>Lists all the accounts in the organization. To request only the accounts in a root or OU, use the <a>ListAccountsForParent</a> operation instead.</p> <p>This operation can be called only from the organization's master account.</p>",
"ListAccountsForParent": "<p>Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that are not in any OU. If you specify an OU, you get a list of all the accounts in only that OU, and not in any child OUs. To get a list of all accounts in the organization, use the <a>ListAccounts</a> operation.</p>",
"ListChildren": "<p>Lists all of the OUs or accounts that are contained in the specified parent OU or root. This operation, along with <a>ListParents</a> enables you to traverse the tree structure that makes up this root.</p>",
@@ -38,7 +38,7 @@
"ListRoots": "<p>Lists the roots that are defined in the current organization.</p> <p>This operation can be called only from the organization's master account.</p>",
"ListTargetsForPolicy": "<p>Lists all the roots, OUs, and accounts to which the specified policy is attached.</p> <p>This operation can be called only from the organization's master account.</p>",
"MoveAccount": "<p>Moves an account from its current source parent root or OU to the specified destination parent root or OU.</p> <p>This operation can be called only from the organization's master account.</p>",
"RemoveAccountFromOrganization": "<p>Removes the specified account from the organization.</p> <p>The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization.</p> <p>This operation can be called only from the organization's master account. Member accounts can remove themselves with <a>LeaveOrganization</a> instead.</p> <important> <ul> <li> <p>You can remove only accounts that were created outside your organization and invited to join. If you created the account using the AWS Organizations console, the Organizations API, or the Organizations CLI commands, then you cannot remove the account.</p> </li> <li> <p>You can remove a member account only after you enable IAM user access to billing in the member account. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </li> </ul> </important>",
"RemoveAccountFromOrganization": "<p>Removes the specified account from the organization.</p> <p>The removed account becomes a stand-alone account that is not a member of any organization. It is no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it is removed from the organization.</p> <p>This operation can be called only from the organization's master account. Member accounts can remove themselves with <a>LeaveOrganization</a> instead.</p> <important> <ul> <li> <p>You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is <i>not</i> automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\"> To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>You can remove a member account only after you enable IAM user access to billing in the member account. For more information, see <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate\">Activating Access to the Billing and Cost Management Console</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </li> </ul> </important>",
"UpdateOrganizationalUnit": "<p>Renames the specified organizational unit (OU). The ID and ARN do not change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached. </p> <p>This operation can be called only from the organization's master account.</p>",
"UpdatePolicy": "<p>Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.</p> <p>This operation can be called only from the organization's master account.</p>"
},
@@ -190,7 +190,7 @@
}
},
"ConstraintViolationException": {
"base": "<p>Performing this operation violates a minimum or maximum value limit. For example, attempting to removing the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:</p> <p/> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit. </p> <p>Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.</p> <p> <b>Note</b>: deleted and closed accounts still count toward your limit.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.</p> </li> <li> <p>OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.</p> </li> <li> <p>OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.</p> </li> <li> <p>POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.</p> </li> <li> <p>MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.</p> </li> <li> <p>MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.</p> </li> <li> <p>ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the End-User License Agreement (EULA).</p> </li> <li> <p>ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification.</p> </li> <li> <p>MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account.</p> </li> <li> <p>MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account.</p> </li> <li> <p>ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.</p> </li> <li> <p>MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.</p> </li> </ul>",
"base": "<p>Performing this operation violates a minimum or maximum value limit. For example, attempting to removing the last SCP from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:</p> <p/> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit. </p> <p>Or, The number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations, or contact AWS Support to request an increase in the number of accounts.</p> <p> <b>Note</b>: deleted and closed accounts still count toward your limit.</p> <important> <p>If you get an exception that indicates that you exceeded your account limits for the organization or that you can\"t add an account because your organization is still initializing, please contact <a href=\"https://console.aws.amazon.com/support/home#/\"> AWS Customer Support</a>.</p> </important> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.</p> </li> <li> <p>OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of organizational units you can have in an organization.</p> </li> <li> <p>OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an organizational unit tree that is too many levels deep.</p> </li> <li> <p>POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.</p> </li> <li> <p>MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.</p> </li> <li> <p>MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.</p> </li> <li> <p>ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that does not yet have enough information to exist as a stand-alone account. This account requires you to first complete phone verification. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a payment instrument, such as a credit card, with the account. Follow the steps at <a href=\"http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_remove.html#leave-without-all-info\">To leave an organization when all required account information has not yet been provided</a> in the <i>AWS Organizations User Guide</i>.</p> </li> <li> <p>ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.</p> </li> <li> <p>MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.</p> </li> <li> <p>MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.</p> </li> </ul>",
"refs": {
}
},
@@ -409,7 +409,7 @@
"base": null,
"refs": {
"Account$Email": "<p>The email address associated with the AWS account.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for this parameter is a string of characters that represents a standard Internet email address.</p>",
"CreateAccountRequest$Email": "<p>The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account.</p>",
"CreateAccountRequest$Email": "<p>The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You cannot access the root user of the account or remove an account that was created with an invalid email address.</p>",
"Organization$MasterAccountEmail": "<p>The email address that is associated with the AWS account that is designated as the master account for the organization.</p>"
}
},
@@ -516,7 +516,7 @@
}
},
"HandshakeConstraintViolationException": {
"base": "<p>The requested operation would violate the constraint identified in the reason code.</p> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. <b>Note</b>: deleted and closed accounts still count toward your limit.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.</p> </li> <li> <p>ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.</p> </li> <li> <p>ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.</p> </li> <li> <p>INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You cannot issue new invitations to join an organization while it is in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.</p> </li> <li> <p>PAYMENT_INSTRUMENT_REQUIRED: You cannot complete the operation with an account that does not have a payment instrument, such as a credit card, associated with it.</p> </li> <li> <p>ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.</p> </li> <li> <p>ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.</p> </li> </ul>",
"base": "<p>The requested operation would violate the constraint identified in the reason code.</p> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. <b>Note</b>: deleted and closed accounts still count toward your limit.</p> <important> <p>If you get an exception that indicates that you exceeded your account limits for the organization or that you can\"t add an account because your organization is still initializing, please contact <a href=\"https://console.aws.amazon.com/support/home#/\"> AWS Customer Support</a>.</p> </important> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day.</p> </li> <li> <p>ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.</p> </li> <li> <p>ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.</p> </li> <li> <p>INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You cannot issue new invitations to join an organization while it is in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.</p> </li> <li> <p>PAYMENT_INSTRUMENT_REQUIRED: You cannot complete the operation with an account that does not have a payment instrument, such as a credit card, associated with it.</p> </li> <li> <p>ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.</p> </li> <li> <p>ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.</p> </li> </ul>",
"refs": {
}
},
@@ -565,7 +565,7 @@
"base": "<p>Identifies a participant in a handshake.</p>",
"refs": {
"HandshakeParties$member": null,
"InviteAccountToOrganizationRequest$Target": "<p>The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements: </p> <p> <code>{ \"Type\": \"ACCOUNT\", \"Id\": \"&lt;<i> <b>account id number</b> </i>&gt;\" }</code> </p> <p>If you use the AWS CLI, you can submit this as a single string, similar to the following example:</p> <p> <code>--target id=123456789012,type=ACCOUNT</code> </p> <p>If you specify <code>\"Type\": \"ACCOUNT\"</code>, then you must provide the AWS account ID number as the <code>Id</code>. If you specify <code>\"Type\": \"EMAIL\"</code>, then you must specify the email address that is associated with the account.</p> <p> <code>--target id=bill@example.com,type=EMAIL</code> </p>"
"InviteAccountToOrganizationRequest$Target": "<p>The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements: </p> <p> <code>{ \"Type\": \"ACCOUNT\", \"Id\": \"&lt;<i> <b>account id number</b> </i>&gt;\" }</code> </p> <p>If you use the AWS CLI, you can submit this as a single string, similar to the following example:</p> <p> <code>--target Id=123456789012,Type=ACCOUNT</code> </p> <p>If you specify <code>\"Type\": \"ACCOUNT\"</code>, then you must provide the AWS account ID number as the <code>Id</code>. If you specify <code>\"Type\": \"EMAIL\"</code>, then you must specify the email address that is associated with the account.</p> <p> <code>--target Id=bill@example.com,Type=EMAIL</code> </p>"
}
},
"HandshakePartyId": {
@@ -1119,7 +1119,7 @@
"RootId": {
"base": null,
"refs": {
"DisablePolicyTypeRequest$RootId": "<p>The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the <a>ListPolicies</a> operation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a root ID string requires \"r-\" followed by from 4 to 32 lower-case letters or digits.</p>",
"DisablePolicyTypeRequest$RootId": "<p>The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the <a>ListRoots</a> operation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a root ID string requires \"r-\" followed by from 4 to 32 lower-case letters or digits.</p>",
"EnablePolicyTypeRequest$RootId": "<p>The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the <a>ListRoots</a> operation.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a root ID string requires \"r-\" followed by from 4 to 32 lower-case letters or digits.</p>",
"Root$Id": "<p>The unique identifier (ID) for the root.</p> <p>The <a href=\"http://wikipedia.org/wiki/regex\">regex pattern</a> for a root ID string requires \"r-\" followed by from 4 to 32 lower-case letters or digits.</p>"
}

989
vendor/github.com/aws/aws-sdk-go/models/apis/pinpoint/2016-12-01/api-2.json generated vendored
View File

File diff suppressed because it is too large Load Diff

227
vendor/github.com/aws/aws-sdk-go/models/apis/pinpoint/2016-12-01/docs-2.json generated vendored
View File

@@ -2,20 +2,28 @@
"version" : "2.0",
"service" : null,
"operations" : {
"CreateApp" : "Creates or updates an app.",
"CreateCampaign" : "Creates or updates a campaign.",
"CreateImportJob" : "Creates or updates an import job.",
"CreateSegment" : "Used to create or update a segment.",
"DeleteAdmChannel" : "Delete an ADM channel",
"DeleteApnsChannel" : "Deletes the APNs channel for an app.",
"DeleteApnsSandboxChannel" : "Delete an APNS sandbox channel",
"DeleteApp" : "Deletes an app.",
"DeleteBaiduChannel" : "Delete a BAIDU GCM channel",
"DeleteCampaign" : "Deletes a campaign.",
"DeleteEmailChannel" : "Delete an email channel",
"DeleteEventStream" : "Deletes the event stream for an app.",
"DeleteGcmChannel" : "Deletes the GCM channel for an app.",
"DeleteSegment" : "Deletes a segment.",
"DeleteSmsChannel" : "Delete an SMS channel",
"GetAdmChannel" : "Get an ADM channel",
"GetApnsChannel" : "Returns information about the APNs channel for an app.",
"GetApnsSandboxChannel" : "Get an APNS sandbox channel",
"GetApp" : "Returns information about an app.",
"GetApplicationSettings" : "Used to request the settings for an app.",
"GetApps" : "Returns information about your apps.",
"GetBaiduChannel" : "Get a BAIDU GCM channel",
"GetCampaign" : "Returns information about a campaign.",
"GetCampaignActivities" : "Returns information about the activity performed by a campaign.",
"GetCampaignVersion" : "Returns information about a specific version of a campaign.",
@@ -35,9 +43,12 @@
"GetSmsChannel" : "Get an SMS channel",
"PutEventStream" : "Use to create or update the event stream for an app.",
"SendMessages" : "Send a batch of messages",
"SendUsersMessages" : "Send a batch of messages to users",
"UpdateAdmChannel" : "Update an ADM channel",
"UpdateApnsChannel" : "Use to update the APNs channel for an app.",
"UpdateApnsSandboxChannel" : "Update an APNS sandbox channel",
"UpdateApplicationSettings" : "Used to update the settings for an app.",
"UpdateBaiduChannel" : "Update a BAIDU GCM channel",
"UpdateCampaign" : "Use to update a campaign.",
"UpdateEmailChannel" : "Update an email channel",
"UpdateEndpoint" : "Use to update an endpoint.",
@@ -47,6 +58,20 @@
"UpdateSmsChannel" : "Update an SMS channel"
},
"shapes" : {
"ADMChannelRequest" : {
"base" : "Amazon Device Messaging channel definition.",
"refs" : { }
},
"ADMChannelResponse" : {
"base" : "Amazon Device Messaging channel definition.",
"refs" : { }
},
"ADMMessage" : {
"base" : "ADM Message.",
"refs" : {
"DirectMessageConfiguration$ADMMessage" : "The message to ADM channels. Overrides the default push notification message."
}
},
"APNSChannelRequest" : {
"base" : "Apple Push Notification Service channel definition.",
"refs" : { }
@@ -72,7 +97,9 @@
"Action" : {
"base" : null,
"refs" : {
"ADMMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"APNSMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"BaiduMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"DefaultPushNotificationMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"GCMMessage$Action" : "The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL",
"Message$Action" : "The action that occurs if the user taps a push notification delivered by the campaign:\nOPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.\n\nDEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.\n\nURL - The default mobile browser on the user's device launches and opens a web page at the URL you specify."
@@ -94,10 +121,20 @@
"MessageRequest$Addresses" : "A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value."
}
},
"ApplicationResponse" : {
"base" : "Application Response.",
"refs" : {
"ApplicationsResponse$Item" : "List of applications returned in this page."
}
},
"ApplicationSettingsResource" : {
"base" : "Application settings.",
"refs" : { }
},
"ApplicationsResponse" : {
"base" : "Get Applications Result.",
"refs" : { }
},
"AttributeDimension" : {
"base" : "Custom attibute dimension",
"refs" : {
@@ -115,6 +152,20 @@
"base" : null,
"refs" : { }
},
"BaiduChannelRequest" : {
"base" : "Baidu Cloud Push credentials",
"refs" : { }
},
"BaiduChannelResponse" : {
"base" : "Baidu Cloud Messaging channel definition",
"refs" : { }
},
"BaiduMessage" : {
"base" : "Baidu Message.",
"refs" : {
"DirectMessageConfiguration$BaiduMessage" : "The message to Baidu GCM channels. Overrides the default push notification message."
}
},
"CampaignEmailMessage" : {
"base" : "The email message configuration.",
"refs" : {
@@ -163,12 +214,16 @@
"ChannelType" : {
"base" : null,
"refs" : {
"AddressConfiguration$ChannelType" : "Type of channel of this address",
"EndpointBatchItem$ChannelType" : "The channel type.\n\nValid values: APNS, GCM",
"EndpointRequest$ChannelType" : "The channel type.\n\nValid values: APNS, GCM",
"EndpointResponse$ChannelType" : "The channel type.\n\nValid values: APNS, GCM"
"AddressConfiguration$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL",
"EndpointBatchItem$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL",
"EndpointRequest$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL",
"EndpointResponse$ChannelType" : "The channel type.\n\nValid values: GCM | APNS | SMS | EMAIL"
}
},
"CreateApplicationRequest" : {
"base" : "Application Request.",
"refs" : { }
},
"DefaultMessage" : {
"base" : "Default Message across push notification, email, and sms.",
"refs" : {
@@ -184,6 +239,7 @@
"DeliveryStatus" : {
"base" : null,
"refs" : {
"EndpointMessageResult$DeliveryStatus" : "Delivery status of message.",
"MessageResult$DeliveryStatus" : "Delivery status of message."
}
},
@@ -196,7 +252,8 @@
"DirectMessageConfiguration" : {
"base" : "The message configuration.",
"refs" : {
"MessageRequest$MessageConfiguration" : "Message configuration."
"MessageRequest$MessageConfiguration" : "Message configuration.",
"SendUsersMessageRequest$MessageConfiguration" : "Message configuration."
}
},
"Duration" : {
@@ -213,6 +270,12 @@
"base" : "Email Channel Response.",
"refs" : { }
},
"EmailMessage" : {
"base" : "Email Message.",
"refs" : {
"DirectMessageConfiguration$EmailMessage" : "The message to Email channels. Overrides the default message."
}
},
"EndpointBatchItem" : {
"base" : "Endpoint update request",
"refs" : {
@@ -239,6 +302,13 @@
"EndpointResponse$Location" : "The endpoint location attributes."
}
},
"EndpointMessageResult" : {
"base" : "The result from sending a message to an endpoint.",
"refs" : {
"MessageResponse$EndpointResult" : "A map containing a multi part response for each address, with the endpointId as the key and the result as the value.",
"SendUsersMessageResponse$Result" : "A map containing of UserId to Map of EndpointId to Endpoint Message Result."
}
},
"EndpointRequest" : {
"base" : "Endpoint update request",
"refs" : { }
@@ -247,6 +317,13 @@
"base" : "Endpoint response",
"refs" : { }
},
"EndpointSendConfiguration" : {
"base" : "Endpoint send configuration.",
"refs" : {
"MessageRequest$Endpoints" : "A map of destination addresses, with the address as the key(Email address, phone number or push token) and the Address Configuration as the value.",
"SendUsersMessageRequest$Users" : "A map of destination endpoints, with the EndpointId as the key Endpoint Message Configuration as the value."
}
},
"EndpointUser" : {
"base" : "Endpoint user specific custom userAttributes",
"refs" : {
@@ -325,6 +402,10 @@
"base" : null,
"refs" : { }
},
"ListOfApplicationResponse" : {
"base" : null,
"refs" : { }
},
"ListOfCampaignResponse" : {
"base" : null,
"refs" : { }
@@ -361,10 +442,22 @@
"base" : null,
"refs" : { }
},
"MapOfEndpointMessageResult" : {
"base" : null,
"refs" : { }
},
"MapOfEndpointSendConfiguration" : {
"base" : null,
"refs" : { }
},
"MapOfListOf__string" : {
"base" : null,
"refs" : { }
},
"MapOfMapOfEndpointMessageResult" : {
"base" : null,
"refs" : { }
},
"MapOfMessageResult" : {
"base" : null,
"refs" : { }
@@ -521,6 +614,14 @@
"base" : "Segments in your account.",
"refs" : { }
},
"SendUsersMessageRequest" : {
"base" : "Send message request.",
"refs" : { }
},
"SendUsersMessageResponse" : {
"base" : "User send message response.",
"refs" : { }
},
"SetDimension" : {
"base" : "Dimension specification of a segment.",
"refs" : {
@@ -568,6 +669,10 @@
"__boolean" : {
"base" : null,
"refs" : {
"ADMChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"ADMChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"ADMChannelResponse$IsArchived" : "Is this channel archived",
"ADMMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"APNSChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"APNSChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"APNSChannelResponse$IsArchived" : "Is this channel archived",
@@ -575,6 +680,10 @@
"APNSSandboxChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"APNSSandboxChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"APNSSandboxChannelResponse$IsArchived" : "Is this channel archived",
"BaiduChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
"BaiduChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"BaiduChannelResponse$IsArchived" : "Is this channel archived",
"BaiduMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"CampaignResponse$IsPaused" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.",
"DefaultPushNotificationMessage$SilentPush" : "Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.",
"EmailChannelRequest$Enabled" : "If the channel is enabled for sending messages.",
@@ -593,7 +702,8 @@
"SMSChannelResponse$Enabled" : "If the channel is enabled for sending messages.",
"SMSChannelResponse$IsArchived" : "Is this channel archived",
"Schedule$IsLocalTime" : "Indicates whether the campaign schedule takes effect according to each user's local time.",
"WriteCampaignRequest$IsPaused" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false."
"WriteCampaignRequest$IsPaused" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false.",
"WriteCampaignRequest$Trace" : "Whether or not to enable trace logging for the campaign. Undocumented"
}
},
"__double" : {
@@ -606,6 +716,7 @@
"__integer" : {
"base" : null,
"refs" : {
"ADMChannelResponse$Version" : "Version of channel",
"APNSChannelResponse$Version" : "Version of channel",
"APNSMessage$Badge" : "Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.",
"APNSSandboxChannelResponse$Version" : "Version of channel",
@@ -613,12 +724,16 @@
"ActivityResponse$TimezonesCompletedCount" : "The total number of timezones completed.",
"ActivityResponse$TimezonesTotalCount" : "The total number of unique timezones present in the segment.",
"ActivityResponse$TotalEndpointCount" : "The total number of endpoints to which the campaign attempts to deliver messages.",
"BaiduChannelResponse$Version" : "Version of channel",
"CampaignLimits$Daily" : "The maximum number of messages that the campaign can send daily.",
"CampaignLimits$MaximumDuration" : "The maximum duration of a campaign from the scheduled start. Must be a minimum of 60 seconds.",
"CampaignLimits$MessagesPerSecond" : "The maximum number of messages per second that the campaign will send. This is a best effort maximum cap and can go as high as 20000 and as low as 50",
"CampaignLimits$Total" : "The maximum total number of messages that the campaign can send.",
"CampaignResponse$HoldoutPercent" : "The allocated percentage of end users who will not receive messages from this campaign.",
"CampaignResponse$SegmentVersion" : "The version of the segment to which the campaign sends messages.",
"CampaignResponse$Version" : "The campaign version number.",
"EmailChannelResponse$Version" : "Version of channel",
"EndpointMessageResult$StatusCode" : "Downstream service status code.",
"GCMChannelResponse$Version" : "Version of channel",
"ImportJobResponse$CompletedPieces" : "The number of pieces that have successfully imported as of the time of the request.",
"ImportJobResponse$FailedPieces" : "The number of pieces that have failed to import as of the time of the request.",
@@ -638,30 +753,63 @@
"__string" : {
"base" : null,
"refs" : {
"ADMChannelRequest$ClientId" : "Client ID as gotten from Amazon",
"ADMChannelRequest$ClientSecret" : "Client secret as gotten from Amazon",
"ADMChannelResponse$ApplicationId" : "Application id",
"ADMChannelResponse$CreationDate" : "When was this segment created",
"ADMChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"ADMChannelResponse$LastModifiedBy" : "Who last updated this entry",
"ADMChannelResponse$LastModifiedDate" : "Last date this was updated",
"ADMChannelResponse$Platform" : "Platform type. Will be \"ADM\"",
"ADMMessage$Body" : "The message body of the notification, the email body or the text message.",
"ADMMessage$ConsolidationKey" : "Optional. Arbitrary string used to indicate multiple messages are logically the same and that ADM is allowed to drop previously enqueued messages in favor of this one.",
"ADMMessage$ExpiresAfter" : "Optional. Number of seconds ADM should retain the message if the device is offline",
"ADMMessage$IconReference" : "The icon image name of the asset saved in your application.",
"ADMMessage$ImageIconUrl" : "The URL that points to an image used as the large icon to the notification content view.",
"ADMMessage$ImageUrl" : "The URL that points to an image used in the push notification.",
"ADMMessage$JsonData" : "The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object",
"ADMMessage$MD5" : "Optional. Base-64-encoded MD5 checksum of the data parameter. Used to verify data integrity",
"ADMMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"ADMMessage$SmallImageIconUrl" : "The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view",
"ADMMessage$Sound" : "Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/",
"ADMMessage$Title" : "The message title that displays above the message on the user's device.",
"ADMMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"APNSChannelRequest$BundleId" : "The bundle id used for APNs Tokens.",
"APNSChannelRequest$Certificate" : "The distribution certificate from Apple.",
"APNSChannelRequest$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSChannelRequest$PrivateKey" : "The certificate private key.",
"APNSChannelRequest$TeamId" : "The team id used for APNs Tokens.",
"APNSChannelRequest$TokenKey" : "The token key used for APNs Tokens.",
"APNSChannelRequest$TokenKeyId" : "The token key used for APNs Tokens.",
"APNSChannelResponse$ApplicationId" : "The ID of the application to which the channel applies.",
"APNSChannelResponse$CreationDate" : "When was this segment created",
"APNSChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"APNSChannelResponse$Id" : "Channel ID. Not used. Present only for backwards compatibility.",
"APNSChannelResponse$LastModifiedBy" : "Who last updated this entry",
"APNSChannelResponse$LastModifiedDate" : "Last date this was updated",
"APNSChannelResponse$Platform" : "The platform type. Will be APNS.",
"APNSMessage$Body" : "The message body of the notification, the email body or the text message.",
"APNSMessage$Category" : "Provide this key with a string value that represents the notification's type. This value corresponds to the value in the identifier property of one of your app's registered categories.",
"APNSMessage$JsonData" : "The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object",
"APNSMessage$MediaUrl" : "The URL that points to a video used in the push notification.",
"APNSMessage$PreferredAuthenticationMethod" : "The preferred authentication method, either \"CERTIFICATE\" or \"TOKEN\"",
"APNSMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"APNSMessage$Sound" : "Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app's main bundle or in the Library/Sounds folder of your app's data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.",
"APNSMessage$ThreadId" : "Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.",
"APNSMessage$Title" : "The message title that displays above the message on the user's device.",
"APNSMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"APNSSandboxChannelRequest$BundleId" : "The bundle id used for APNs Tokens.",
"APNSSandboxChannelRequest$Certificate" : "The distribution certificate from Apple.",
"APNSSandboxChannelRequest$DefaultAuthenticationMethod" : "The default authentication method used for APNs.",
"APNSSandboxChannelRequest$PrivateKey" : "The certificate private key.",
"APNSSandboxChannelRequest$TeamId" : "The team id used for APNs Tokens.",
"APNSSandboxChannelRequest$TokenKey" : "The token key used for APNs Tokens.",
"APNSSandboxChannelRequest$TokenKeyId" : "The token key used for APNs Tokens.",
"APNSSandboxChannelResponse$ApplicationId" : "Application id",
"APNSSandboxChannelResponse$CreationDate" : "When was this segment created",
"APNSSandboxChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"APNSSandboxChannelResponse$LastModifiedBy" : "Who last updated this entry",
"APNSSandboxChannelResponse$LastModifiedDate" : "Last date this was updated",
"APNSSandboxChannelResponse$Platform" : "The platform type. Will be APNS.",
"APNSSandboxChannelResponse$Platform" : "The platform type. Will be APNS_SANDBOX.",
"ActivityResponse$ApplicationId" : "The ID of the application to which the campaign applies.",
"ActivityResponse$CampaignId" : "The ID of the campaign to which the activity applies.",
"ActivityResponse$End" : "The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.",
@@ -674,9 +822,32 @@
"AddressConfiguration$BodyOverride" : "Body override. If specified will override default body.",
"AddressConfiguration$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"AddressConfiguration$TitleOverride" : "Title override. If specified will override default title if applicable.",
"ApplicationResponse$Id" : "The unique application ID.",
"ApplicationResponse$Name" : "The display name of the application.",
"ApplicationSettingsResource$ApplicationId" : "The unique ID for the application.",
"ApplicationSettingsResource$LastModifiedDate" : "The date that the settings were last updated in ISO 8601 format.",
"ApplicationsResponse$NextToken" : "The string that you use in a subsequent request to get the next page of results in a paginated response.",
"BaiduChannelRequest$ApiKey" : "Platform credential API key from Baidu.",
"BaiduChannelRequest$SecretKey" : "Platform credential Secret key from Baidu.",
"BaiduChannelResponse$ApplicationId" : "Application id",
"BaiduChannelResponse$CreationDate" : "When was this segment created",
"BaiduChannelResponse$Credential" : "The Baidu API key from Baidu.",
"BaiduChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"BaiduChannelResponse$LastModifiedBy" : "Who made the last change",
"BaiduChannelResponse$LastModifiedDate" : "Last date this was updated",
"BaiduChannelResponse$Platform" : "The platform type. Will be BAIDU",
"BaiduMessage$Body" : "The message body of the notification, the email body or the text message.",
"BaiduMessage$IconReference" : "The icon image name of the asset saved in your application.",
"BaiduMessage$ImageIconUrl" : "The URL that points to an image used as the large icon to the notification content view.",
"BaiduMessage$ImageUrl" : "The URL that points to an image used in the push notification.",
"BaiduMessage$JsonData" : "The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object",
"BaiduMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"BaiduMessage$SmallImageIconUrl" : "The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view",
"BaiduMessage$Sound" : "Indicates a sound to play when the device receives the notification. Supports default, or the filename of a sound resource bundled in the app. Android sound files must reside in /res/raw/",
"BaiduMessage$Title" : "The message title that displays above the message on the user's device.",
"BaiduMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"CampaignEmailMessage$Body" : "The email text body.",
"CampaignEmailMessage$FromAddress" : "The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.",
"CampaignEmailMessage$HtmlBody" : "The email html body.",
"CampaignEmailMessage$Title" : "The email title (Or subject).",
"CampaignResponse$ApplicationId" : "The ID of the application to which the campaign applies.",
@@ -691,14 +862,16 @@
"CampaignSmsMessage$Body" : "The SMS text body.",
"CampaignSmsMessage$SenderId" : "Sender ID of sent message.",
"CampaignsResponse$NextToken" : "The string that you use in a subsequent request to get the next page of results in a paginated response.",
"CreateApplicationRequest$Name" : "The display name of the application. Used in the Amazon Pinpoint console.",
"DefaultMessage$Body" : "The message body of the notification, the email body or the text message.",
"DefaultPushNotificationMessage$Body" : "The message body of the notification, the email body or the text message.",
"DefaultPushNotificationMessage$JsonData" : "The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object",
"DefaultPushNotificationMessage$Title" : "The message title that displays above the message on the user's device.",
"DefaultPushNotificationMessage$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"EmailChannelRequest$FromAddress" : "The email address used to send emails from.",
"EmailChannelRequest$Identity" : "The ARN of an identity verified with SES.",
"EmailChannelRequest$RoleArn" : "The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service",
"EmailChannelResponse$ApplicationId" : "Application id",
"EmailChannelResponse$ApplicationId" : "The unique ID of the application to which the email channel belongs.",
"EmailChannelResponse$CreationDate" : "The date that the settings were last updated in ISO 8601 format.",
"EmailChannelResponse$FromAddress" : "The email address used to send emails from.",
"EmailChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
@@ -707,11 +880,16 @@
"EmailChannelResponse$LastModifiedDate" : "Last date this was updated",
"EmailChannelResponse$Platform" : "Platform type. Will be \"EMAIL\"",
"EmailChannelResponse$RoleArn" : "The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service",
"EmailMessage$Body" : "The message body of the notification, the email body or the text message.",
"EmailMessage$FromAddress" : "The email address used to send the email from. Defaults to use FromAddress specified in the Email Channel.",
"EmailMessage$HtmlBody" : "The HTML part of the email.",
"EmailMessage$TemplateArn" : "The ARN of the template to use for the email.",
"EmailMessage$Title" : "The subject of the email.",
"EndpointBatchItem$Address" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).",
"EndpointBatchItem$EffectiveDate" : "The last time the endpoint was updated. Provided in ISO 8601 format.",
"EndpointBatchItem$EndpointStatus" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.",
"EndpointBatchItem$Id" : "The unique Id for the Endpoint in the batch.",
"EndpointBatchItem$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages.",
"EndpointBatchItem$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL - User has opted out of all messages.\n\nNONE - Users has not opted out and receives all messages.",
"EndpointBatchItem$RequestId" : "The unique ID for the most recent request to update the endpoint.",
"EndpointDemographic$AppVersion" : "The version of the application associated with the endpoint.",
"EndpointDemographic$Locale" : "The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.\n",
@@ -725,10 +903,13 @@
"EndpointLocation$Country" : "Country according to ISO 3166-1 Alpha-2 codes. For example, US.",
"EndpointLocation$PostalCode" : "The postal code or zip code of the endpoint.",
"EndpointLocation$Region" : "The region of the endpoint location. For example, corresponds to a state in US.",
"EndpointMessageResult$Address" : "Address that endpoint message was delivered to.",
"EndpointMessageResult$StatusMessage" : "Status message for message delivery.",
"EndpointMessageResult$UpdatedToken" : "If token was updated as part of delivery. (This is GCM Specific)",
"EndpointRequest$Address" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).",
"EndpointRequest$EffectiveDate" : "The last time the endpoint was updated. Provided in ISO 8601 format.",
"EndpointRequest$EndpointStatus" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.",
"EndpointRequest$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages.",
"EndpointRequest$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL - User has opted out of all messages.\n\nNONE - Users has not opted out and receives all messages.",
"EndpointRequest$RequestId" : "The unique ID for the most recent request to update the endpoint.",
"EndpointResponse$Address" : "The address or token of the endpoint as provided by your push provider (e.g. DeviceToken or RegistrationId).",
"EndpointResponse$ApplicationId" : "The ID of the application associated with the endpoint.",
@@ -737,8 +918,12 @@
"EndpointResponse$EffectiveDate" : "The last time the endpoint was updated. Provided in ISO 8601 format.",
"EndpointResponse$EndpointStatus" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated.",
"EndpointResponse$Id" : "The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application.",
"EndpointResponse$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages.",
"EndpointResponse$OptOut" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL - User has opted out of all messages.\n\nNONE - Users has not opted out and receives all messages.",
"EndpointResponse$RequestId" : "The unique ID for the most recent request to update the endpoint.",
"EndpointResponse$ShardId" : "The ShardId of endpoint.",
"EndpointSendConfiguration$BodyOverride" : "Body override. If specified will override default body.",
"EndpointSendConfiguration$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"EndpointSendConfiguration$TitleOverride" : "Title override. If specified will override default title if applicable.",
"EndpointUser$UserId" : "The unique ID of the user.",
"EventStream$ApplicationId" : "The ID of the application from which events should be published.",
"EventStream$DestinationStreamArn" : "The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.\n Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME\n Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME",
@@ -750,7 +935,7 @@
"GCMChannelResponse$ApplicationId" : "The ID of the application to which the channel applies.",
"GCMChannelResponse$CreationDate" : "When was this segment created",
"GCMChannelResponse$Credential" : "The GCM API key from Google.",
"GCMChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"GCMChannelResponse$Id" : "Channel ID. Not used. Present only for backwards compatibility.",
"GCMChannelResponse$LastModifiedBy" : "Who last updated this entry",
"GCMChannelResponse$LastModifiedDate" : "Last date this was updated",
"GCMChannelResponse$Platform" : "The platform type. Will be GCM",
@@ -759,6 +944,7 @@
"GCMMessage$IconReference" : "The icon image name of the asset saved in your application.",
"GCMMessage$ImageIconUrl" : "The URL that points to an image used as the large icon to the notification content view.",
"GCMMessage$ImageUrl" : "The URL that points to an image used in the push notification.",
"GCMMessage$JsonData" : "The data payload used for a silent push. This payload is added to the notifications' data.pinpoint.jsonBody' object",
"GCMMessage$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"GCMMessage$RestrictedPackageName" : "This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.",
"GCMMessage$SmallImageIconUrl" : "The URL that points to an image used as the small icon for the notification which will be used to represent the notification in the status bar and content view",
@@ -787,10 +973,12 @@
"Message$ImageUrl" : "The URL that points to an image used in the push notification.",
"Message$JsonBody" : "The JSON payload used for a silent push.",
"Message$MediaUrl" : "The URL that points to the media resource, for example a .mp4 or .gif file.",
"Message$RawContent" : "The Raw JSON formatted string to be used as the payload. This value overrides the message.",
"Message$Title" : "The message title that displays above the message on the user's device.",
"Message$Url" : "The URL to open in the user's mobile browser. Used if the value for Action is URL.",
"MessageBody$Message" : "The error message returned from the API.",
"MessageBody$RequestID" : "The unique message body ID.",
"MessageRequest$RequestId" : "Original request Id for which this message is delivered.",
"MessageResponse$ApplicationId" : "Application id of the message.",
"MessageResponse$RequestId" : "Original request Id for which this message was delivered.",
"MessageResult$StatusMessage" : "Status message for message delivery.",
@@ -798,7 +986,8 @@
"QuietTime$End" : "The default end time for quiet time in ISO 8601 format.",
"QuietTime$Start" : "The default start time for quiet time in ISO 8601 format.",
"SMSChannelRequest$SenderId" : "Sender identifier of your messages.",
"SMSChannelResponse$ApplicationId" : "Application id",
"SMSChannelRequest$ShortCode" : "ShortCode registered with phone provider.",
"SMSChannelResponse$ApplicationId" : "The unique ID of the application to which the SMS channel belongs.",
"SMSChannelResponse$CreationDate" : "The date that the settings were last updated in ISO 8601 format.",
"SMSChannelResponse$Id" : "Channel ID. Not used, only for backwards compatibility.",
"SMSChannelResponse$LastModifiedBy" : "Who last updated this entry",
@@ -820,6 +1009,9 @@
"SegmentResponse$LastModifiedDate" : "The date the segment was last updated in ISO 8601 format.",
"SegmentResponse$Name" : "The name of segment",
"SegmentsResponse$NextToken" : "An identifier used to retrieve the next page of results. The token is null if no additional pages exist.",
"SendUsersMessageRequest$RequestId" : "Original request Id for which this message is delivered.",
"SendUsersMessageResponse$ApplicationId" : "Application id of the message.",
"SendUsersMessageResponse$RequestId" : "Original request Id for which this message was delivered.",
"TreatmentResource$Id" : "The unique treatment ID.",
"TreatmentResource$TreatmentDescription" : "A custom description for the treatment.",
"TreatmentResource$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing.",
@@ -829,14 +1021,11 @@
"WriteCampaignRequest$TreatmentDescription" : "A custom description for the treatment.",
"WriteCampaignRequest$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing.",
"WriteEventStream$DestinationStreamArn" : "The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.\n Firehose ARN: arn:aws:firehose:REGION:ACCOUNT_ID:deliverystream/STREAM_NAME\n Kinesis ARN: arn:aws:kinesis:REGION:ACCOUNT_ID:stream/STREAM_NAME",
"WriteEventStream$ExternalId" : "The external ID assigned the IAM role that authorizes Amazon Pinpoint to publish to the stream.",
"WriteEventStream$RoleArn" : "The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.",
"WriteSegmentRequest$Name" : "The name of segment",
"WriteTreatmentResource$TreatmentDescription" : "A custom description for the treatment.",
"WriteTreatmentResource$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing.",
"PutEventStreamRequest$ApplicationId": "Application Id.",
"PutEventStreamRequest$WriteEventStream": "Write event stream wrapper.",
"GetEventStreamRequest$ApplicationId": "Application Id.",
"DeleteEventStreamRequest$ApplicationId": "Application Id."
"WriteTreatmentResource$TreatmentName" : "The custom name of a variation of the campaign used for A/B testing."
}
}
}

25
vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/api-2.json generated vendored
View File

@@ -1983,7 +1983,9 @@
"DomainIAMRoleName":{"shape":"String"},
"PromotionTier":{"shape":"IntegerOptional"},
"Timezone":{"shape":"String"},
"EnableIAMDatabaseAuthentication":{"shape":"BooleanOptional"}
"EnableIAMDatabaseAuthentication":{"shape":"BooleanOptional"},
"EnablePerformanceInsights":{"shape":"BooleanOptional"},
"PerformanceInsightsKMSKeyId":{"shape":"String"}
}
},
"CreateDBInstanceReadReplicaMessage":{
@@ -2010,7 +2012,9 @@
"MonitoringRoleArn":{"shape":"String"},
"KmsKeyId":{"shape":"String"},
"PreSignedUrl":{"shape":"String"},
"EnableIAMDatabaseAuthentication":{"shape":"BooleanOptional"}
"EnableIAMDatabaseAuthentication":{"shape":"BooleanOptional"},
"EnablePerformanceInsights":{"shape":"BooleanOptional"},
"PerformanceInsightsKMSKeyId":{"shape":"String"}
}
},
"CreateDBInstanceReadReplicaResult":{
@@ -2522,7 +2526,9 @@
"PromotionTier":{"shape":"IntegerOptional"},
"DBInstanceArn":{"shape":"String"},
"Timezone":{"shape":"String"},
"IAMDatabaseAuthenticationEnabled":{"shape":"Boolean"}
"IAMDatabaseAuthenticationEnabled":{"shape":"Boolean"},
"PerformanceInsightsEnabled":{"shape":"BooleanOptional"},
"PerformanceInsightsKMSKeyId":{"shape":"String"}
},
"wrapper":true
},
@@ -3952,7 +3958,9 @@
"MonitoringRoleArn":{"shape":"String"},
"DomainIAMRoleName":{"shape":"String"},
"PromotionTier":{"shape":"IntegerOptional"},
"EnableIAMDatabaseAuthentication":{"shape":"BooleanOptional"}
"EnableIAMDatabaseAuthentication":{"shape":"BooleanOptional"},
"EnablePerformanceInsights":{"shape":"BooleanOptional"},
"PerformanceInsightsKMSKeyId":{"shape":"String"}
}
},
"ModifyDBInstanceResult":{
@@ -3996,7 +4004,8 @@
"required":["DBSnapshotIdentifier"],
"members":{
"DBSnapshotIdentifier":{"shape":"String"},
"EngineVersion":{"shape":"String"}
"EngineVersion":{"shape":"String"},
"OptionGroupName":{"shape":"String"}
}
},
"ModifyDBSnapshotResult":{
@@ -4153,6 +4162,9 @@
"OptionsConflictsWith":{"shape":"OptionsConflictsWith"},
"Persistent":{"shape":"Boolean"},
"Permanent":{"shape":"Boolean"},
"RequiresAutoMinorEngineVersionUpgrade":{"shape":"Boolean"},
"VpcOnly":{"shape":"Boolean"},
"SupportsOptionVersionDowngrade":{"shape":"BooleanOptional"},
"OptionGroupOptionSettings":{"shape":"OptionGroupOptionSettingsList"},
"OptionGroupOptionVersions":{"shape":"OptionGroupOptionVersionsList"}
}
@@ -4296,7 +4308,8 @@
"StorageType":{"shape":"String"},
"SupportsIops":{"shape":"Boolean"},
"SupportsEnhancedMonitoring":{"shape":"Boolean"},
"SupportsIAMDatabaseAuthentication":{"shape":"Boolean"}
"SupportsIAMDatabaseAuthentication":{"shape":"Boolean"},
"SupportsPerformanceInsights":{"shape":"Boolean"}
},
"wrapper":true
},

149
vendor/github.com/aws/aws-sdk-go/models/apis/rds/2014-10-31/docs-2.json generated vendored
View File

File diff suppressed because one or more lines are too long

54
vendor/github.com/aws/aws-sdk-go/models/apis/rekognition/2016-06-27/api-2.json generated vendored
View File

@@ -612,8 +612,8 @@
"GenderType":{
"type":"string",
"enum":[
"MALE",
"FEMALE"
"Male",
"Female"
]
},
"GetCelebrityInfoRequest":{
@@ -732,31 +732,31 @@
"LandmarkType":{
"type":"string",
"enum":[
"EYE_LEFT",
"EYE_RIGHT",
"NOSE",
"MOUTH_LEFT",
"MOUTH_RIGHT",
"LEFT_EYEBROW_LEFT",
"LEFT_EYEBROW_RIGHT",
"LEFT_EYEBROW_UP",
"RIGHT_EYEBROW_LEFT",
"RIGHT_EYEBROW_RIGHT",
"RIGHT_EYEBROW_UP",
"LEFT_EYE_LEFT",
"LEFT_EYE_RIGHT",
"LEFT_EYE_UP",
"LEFT_EYE_DOWN",
"RIGHT_EYE_LEFT",
"RIGHT_EYE_RIGHT",
"RIGHT_EYE_UP",
"RIGHT_EYE_DOWN",
"NOSE_LEFT",
"NOSE_RIGHT",
"MOUTH_UP",
"MOUTH_DOWN",
"LEFT_PUPIL",
"RIGHT_PUPIL"
"eyeLeft",
"eyeRight",
"nose",
"mouthLeft",
"mouthRight",
"leftEyeBrowLeft",
"leftEyeBrowRight",
"leftEyeBrowUp",
"rightEyeBrowLeft",
"rightEyeBrowRight",
"rightEyeBrowUp",
"leftEyeLeft",
"leftEyeRight",
"leftEyeUp",
"leftEyeDown",
"rightEyeLeft",
"rightEyeRight",
"rightEyeUp",
"rightEyeDown",
"noseLeft",
"noseRight",
"mouthUp",
"mouthDown",
"leftPupil",
"rightPupil"
]
},
"Landmarks":{

4
vendor/github.com/aws/aws-sdk-go/models/apis/rekognition/2016-06-27/docs-2.json generated vendored
View File

@@ -332,8 +332,8 @@
"BoundingBox$Top": "<p>Top coordinate of the bounding box as a ratio of overall image height.</p>",
"ImageQuality$Brightness": "<p>Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.</p>",
"ImageQuality$Sharpness": "<p>Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.</p>",
"Landmark$X": "<p>x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. </p>",
"Landmark$Y": "<p>y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.</p>"
"Landmark$X": "<p>x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5. </p>",
"Landmark$Y": "<p>y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.</p>"
}
},
"Gender": {

30
vendor/github.com/aws/aws-sdk-go/models/apis/rekognition/2016-06-27/examples-1.json generated vendored
View File

@@ -139,27 +139,27 @@
"Confidence": 100,
"Landmarks": [
{
"Type": "EYE_LEFT",
"Type": "eyeLeft",
"X": 0.6394737362861633,
"Y": 0.40819624066352844
},
{
"Type": "EYE_RIGHT",
"Type": "eyeRight",
"X": 0.7266660928726196,
"Y": 0.41039225459098816
},
{
"Type": "NOSE_LEFT",
"Type": "eyeRight",
"X": 0.6912462115287781,
"Y": 0.44240960478782654
},
{
"Type": "MOUTH_DOWN",
"Type": "mouthDown",
"X": 0.6306198239326477,
"Y": 0.46700039505958557
},
{
"Type": "MOUTH_UP",
"Type": "mouthUp",
"X": 0.7215608954429626,
"Y": 0.47114261984825134
}
@@ -262,27 +262,27 @@
"Confidence": 99.9991226196289,
"Landmarks": [
{
"Type": "EYE_LEFT",
"Type": "eyeLeft",
"X": 0.3976764678955078,
"Y": 0.6248345971107483
},
{
"Type": "EYE_RIGHT",
"Type": "eyeRight",
"X": 0.4810936450958252,
"Y": 0.6317117214202881
},
{
"Type": "NOSE_LEFT",
"Type": "noseLeft",
"X": 0.41986238956451416,
"Y": 0.7111940383911133
},
{
"Type": "MOUTH_DOWN",
"Type": "mouthDown",
"X": 0.40525302290916443,
"Y": 0.7497701048851013
},
{
"Type": "MOUTH_UP",
"Type": "mouthUp",
"X": 0.4753248989582062,
"Y": 0.7558549642562866
}
@@ -320,27 +320,27 @@
"Confidence": 99.99950408935547,
"Landmarks": [
{
"Type": "EYE_LEFT",
"Type": "eyeLeft",
"X": 0.6006892323493958,
"Y": 0.290842205286026
},
{
"Type": "EYE_RIGHT",
"Type": "eyeRight",
"X": 0.6808141469955444,
"Y": 0.29609042406082153
},
{
"Type": "NOSE_LEFT",
"Type": "noseLeft",
"X": 0.6395332217216492,
"Y": 0.3522595763206482
},
{
"Type": "MOUTH_DOWN",
"Type": "mouthDown",
"X": 0.5892083048820496,
"Y": 0.38689887523651123
},
{
"Type": "MOUTH_UP",
"Type": "mouthUp",
"X": 0.674560010433197,
"Y": 0.394125759601593
}

Some files were not shown because too many files have changed in this diff Show More